FieldEx Developer
developer notes

Get Sales Order By ID

The SalesOrderByID API allows you to retrieve an existing Sales Order by its ID.

Method API Endpoint
GET {{endpoint}}/api/ext/sales-orders/{id}

Headers

Key Value
Content-Type application/json
Authorization Bearer {{token}}

Example Response

// 200 Response Code
{
    "id": "1",
    "createdDateTime": "2023-05-01T00:34:45Z",
    "modifiedDateTime": "2023-05-30T11:40:38Z",
    "orderName": "Test ad",
    "salesOrderExternalId": "null",
    "orderStartDate": "2023-05-01",
    "orderEndDate": "2023-05-22",
    "orderCurrency": "MYR",
    "description": "null",
    "billingStreet": "KLIA Terminal 2 - International Arrival Hall, Kuala Lumpur International Airport",
    "billingCity": "Sepang",
    "billingState": "Selangor",
    "billingPostalcode": "64000",
    "salesOrderNumber": "SO-000001",
    "shippingStreet": "KLIA Terminal 2 - International Arrival Hall, Kuala Lumpur International Airport",
    "shippingCity": "Sepang",
    "shippingState": "Selangor",
    "orderAmount": "10.0",
    "shippingPostalcode": "64000",
    "shippingPlaceId": "null",
    "billingPlaceId": "null",
    "status": "DRAFT",
    "lastUpdatedDateTimeViaIntegration": "null",
    "contactEmail": "null",
    "totalQty": "0.0",
    "totalPrice": "0.0",
    "billingLatitude": "2.7447148",
    "billingLongitude": "101.6851931",
    "shippingLatitude": "2.7447148",
    "shippingLongitude": "101.6851931",
    "createdBy": {
        "id": "1",
        "login": "load.test1@trial.custella.com",
        "firstName": "Test",
        "lastName": "User MS 123",
        "imageUrl": "null",
        "email": "preeti@fieldex.com",
        "fullName": "Test User MS 123"
    },
    "orderOwner": {
        "id": "1",
        "login": "load.test1@trial.custella.com",
        "firstName": "Test",
        "lastName": "User MS 123",
        "imageUrl": "null",
        "email": "preeti@fieldex.com",
        "fullName": "Test User MS 123"
    },
    "modifiedBy": {
        "id": "1",
        "login": "load.test1@trial.custella.com",
        "firstName": "Test",
        "lastName": "User MS 123",
        "imageUrl": "null",
        "email": "preeti@fieldex.com",
        "fullName": "Test User MS 123"
    },
    "billingContact": null,
    "shippingContact": null,
    "customer": {
        "id": "3",
        "name": "1 Load Test [DO NOT DELETE]",
        "email": "null",
        "isDeleted": "N"
    },
    "country": "null",
    "billingCountry": "Malaysia",
    "shippingCountry": "Malaysia",
    "salesOrderChannel": "null",
    "salesOrderType": "null",
    "tasks": "null",
    "salesOrderProducts": "null",
    "deleted": "false"
}