Get SalesOrder List

Get a list of SalesOrders

Request

Path Params

businessUnitId

string

required

Query Params

sortField

enum<string>

optional

Field to sort by

Allowed values:

statuscustomerOrderNumbercreatedDateshippingSpeedshipTo.namedomsCreatedTimestamp

Default:

domsCreatedTimestamp

sortDirection

enum<string>

optional

Direction in which to sort the sortField

Allowed values:

ASCDESC

Default:

DESC

offset

integer

optional

This offsets the start of each page by the number specified.

Default:

limit

integer

optional

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.

Default:

100

status

string

optional

Filter to orders with this status. Values are:
CREATED = '120',
BACK_ORDERED = '160',
PARTIALLY_ALLOCATED = '165',
ALLOCATED = '170',
WH_DROPPED = '200',
WH_PROCESSING = '210',
WAVED = '260',
PICKING_INITIATED = '265',
PICKING_COMPLETE = '270',
PACKED = '275',
LOADED = '280',
PARTIALLY_SHIPPED = '300',
SHIP_COMPLETE = '400',
CANCELLED = '000'

customerOrderNumber

string

optional

Filter to orders where customerOrderNumber begins with this string.

createdDateSince

string

optional

Start of the range for time-based filter. Date ranges are inclusive. ISO 8601 date string.

createdDateUntil

string

optional

End of the range for time-based filter. Date ranges are inclusive. ISO 8601 date string.

buildingId

string

optional

Filter to order where any part of order is being fulfilled by this building

shippingSpeed

string

optional

Filter to orders with the original requested shipping speed

domsCreatedTimestampSince

string

optional

Start of the range for time-based filter. Date ranges are inclusive. ISO 8601 date string.

domsCreatedTimestampUntil

string

optional

End of the range for time-based filter. Date ranges are inclusive. ISO 8601 date string.

distributionOrderNumber

string

optional

Filter to order that has a distribution order with this distributionOrderNumber

shipToName

string

optional

Filter to orders where shipTo.name contains this string. Case-insensitive.

Responses

🟢200OK

application/json

Body

data

array[object (SalesOrderSummary) {6}]

optional

customerOrderNumber

string

required

<= 30 characters

shipTo

object (Party)

required

orderCreatedDate

string <date-time>

required

The orderCreatedDate used to drive SLAs

status

string

required

Overall sales order status derived by Softeon. An example status of a split sales order may be "Partially Fulfilled." Status values are:
CREATED = '120',
BACK_ORDERED = '160',
PARTIALLY_ALLOCATED = '165',
ALLOCATED = '170',
WH_DROPPED = '200',
WH_PROCESSING = '210',
WAVED = '260',
PICKING_INITIATED = '265',
PICKING_COMPLETE = '270',
PACKED = '275',
LOADED = '280',
PARTIALLY_SHIPPED = '300',
SHIP_COMPLETE = '400',
CANCELLED = '000'

<= 3 characters

shippingSpeed

enum<string>

required

The overall shipping speed requested for the order.

<= 3 characters

Allowed values:

1D2D5A5D

domsCreatedTimestamp

string <date-time>

required

Timestamp for when this order was received and persisted by DOMS

Example

{
    "data": [
        {
            "customerOrderNumber": "string",
            "shipTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "strin",
                "country": "strin",
                "postalCode": "string",
                "email": "foo@bar.com,fish@sea.net",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "orderCreatedDate": "2019-08-24T14:15:22Z",
            "status": "str",
            "shippingSpeed": "1D",
            "domsCreatedTimestamp": "2019-08-24T14:15:22Z"
        }
    ]
}

🟠400Bad Request: - non-numeric paging params - invalid date params - invalid status filter - invalid sort field - etc

🟠404Not Found

🔴500Internal Server Error

Get SalesOrder List

Request

Request samples

Responses