GET
/
v1
/
wholesale_order
/
list
curl --location --request GET 'https://api.stateset.com/v1/wholesale_order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'

{
    "id": "1",
    "name": "Wholesale Order 1",
    "order_number": "WO-1",
    "created_date": "2021-09-01",
    "updated_date": "2021-09-01",
    "order_financial_status": "Paid",
    "order_fulfillment_status": "Fulfilled",
    "order_imported_status": "Imported",
    "delivery_date": "2021-09-01",
    "delivery_address": "123 Main St, Anytown, USA",
    "location": "Anytown",
    "memo": "This is a memo",
    "imported_date": "2021-09-01",
    "customer_number": "123",
    "wholesale_order_line_items": [
        {
            "id": "1",
            "line_status": "Active",
            "line_type": "Product",
            "total_quantity": "10",
            "unit_quantity": "1",
            "wholesale_order_number": "WO-1"
        }
    ]
}

Body

limit
string
required

This is the limit of the wholesale orders.

offset
string
required

This is the offset of the wholesale orders.

order_direction
string
required

This is the order direction of the wholesale orders.

Response

id
string

The Id of the wholesale order

name
string

The name of the wholesale order

order_number
string

The order number of the wholesale order

created_date
string

The date the wholesale order was created

updated_date
string

The date the wholesale order was last updated

order_financial_status
string

The financial status of the wholesale order

order_fulfillment_status
string

The fulfillment status of the wholesale order

order_imported_status
string

The imported status of the wholesale order

delivery_date
string

The delivery date of the wholesale order

delivery_address
string

The delivery address of the wholesale order

location
string

Location or site where the work order is applicable

memo
string

Memo or additional notes related to the work order

imported_date
string

The date the wholesale order was imported

customer_number
string

The customer number of the wholesale order

wholesale_order_line_items
string
curl --location --request GET 'https://api.stateset.com/v1/wholesale_order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "limit": 10,
    "offset": 0,
    "order_direction": "asc"
}'

{
    "id": "1",
    "name": "Wholesale Order 1",
    "order_number": "WO-1",
    "created_date": "2021-09-01",
    "updated_date": "2021-09-01",
    "order_financial_status": "Paid",
    "order_fulfillment_status": "Fulfilled",
    "order_imported_status": "Imported",
    "delivery_date": "2021-09-01",
    "delivery_address": "123 Main St, Anytown, USA",
    "location": "Anytown",
    "memo": "This is a memo",
    "imported_date": "2021-09-01",
    "customer_number": "123",
    "wholesale_order_line_items": [
        {
            "id": "1",
            "line_status": "Active",
            "line_type": "Product",
            "total_quantity": "10",
            "unit_quantity": "1",
            "wholesale_order_number": "WO-1"
        }
    ]
}

Wholesale Order

NameTypeDescription
idTextThe Id of the wholesale order
nameTextThe name of the wholesale order
order_numberTextThe order number of the wholesale order
created_dateDate/TimeThe date the wholesale order was created
updated_dateDate/TimeThe date the wholesale order was last updated
order_financial_statusTextThe financial status of the wholesale order
order_fulfillment_statusTextThe fulfillment status of the wholesale order
order_imported_statusTextThe imported status of the wholesale order
delivery_dateDateThe delivery date of the wholesale order
delivery_addressTextThe delivery address of the wholesale order
locationTextLocation or site where the wholesale order is applicable
memoTextMemo or additional notes related to the wholesale order
imported_dateDate/TimeThe date the wholesale order was imported
customer_numberTextThe customer number of the wholesale order

Wholesale Order Line Items

NameTypeDescription
idTextUnique identifier for the line item
line_statusTextStatus or state of the line item
line_typeTextType or category of the line item
total_quantityNumericTotal quantity of the part or item required or used in the wholesale order
unit_quantityNumericQuantity of the part or item required or used per unit in the wholesale order
wholesale_order_numberTextNumber associated with the wholesale order to which the line item belongs