arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/list_pending_orders

List Pending Orders

Returns a list of orders being held in a pending status before being submitted.

Body

Name Description Type Additional information
ids List of ids associated with pending orders array (number) None.
skus List of skus associated with the orders array (text) None.
account_key Optional - This assigns orders by account_key. Note, this will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and virtual inventory will be updated based upon the user's api credentials. Leave as null if not authorized to use this parameter. text None.

Example JSON Body

application/json, text/json

{
  "ids": [
    1,
    2
  ],
  "skus": [
    "sample string 1",
    "sample string 2"
  ],
  "account_key": "sample string 1"
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/list_pending_orders' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "ids": [
    1,
    2
  ],
  "skus": [
    "sample string 1",
    "sample string 2"
  ],
  "account_key": "sample string 1"
}'