inventory/purchase_order/get

This returns the list of purchase orders available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

purchase_order_id

integer

optional

The purchase order ID to search for specifically.

filter_date_modified

string

optional

Filter the list of purchase orders modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of purchase orders to include deleted records.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "purchase_order_id", "user", "location", "supplier", "total", "date_estimated_arrival", "date_received", "date_added", "date_modified".

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "purchase_order_id": 0,
    "filter_date_modified": "string",
    "filter_deleted": true,
    "page": 0,
    "sort": "string",
    "order": "string",
    "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available.

purchase_orders

array [object {14}]

optional

The list of purchase orders available.

purchase_order_id

integer

required

The purchase order ID.

user_id

integer

required

The user ID last modified the purchase order.

location_id

integer

required

The location ID.

supplier_id

integer

required

The supplier ID.

total

number

required

The purchase order total.

comment

string

required

The comment for the purchase order.

currency

string

required

The currency code.

currency_value

number

required

The currency value.

date_estimated_arrival

string

required

The date estimated arrival.

date_received

string

required

The date received.

date_added

string

required

The date time the purchase order was created.

date_modified

string

required

The date time the purchase order was last modified.

items

array [object {4}]

required

The list of items for the purchase order.

deleted

boolean

optional

Indicates if the purchase order has been deleted. Only returned if filter_deleted is "1".

Example

{
    "error": [
        "string"
    ],
    "total": 0,
    "purchase_orders": [
        {
            "purchase_order_id": 0,
            "user_id": 0,
            "location_id": 0,
            "supplier_id": 0,
            "total": 0,
            "comment": "string",
            "currency": "string",
            "currency_value": 0,
            "date_estimated_arrival": "string",
            "date_received": "string",
            "date_added": "string",
            "date_modified": "string",
            "items": [
                {
                    "item_id": 0,
                    "name": "string",
                    "quantity": 0,
                    "cost": 0
                }
            ],
            "deleted": true
        }
    ]
}