Order and Inventory
Order and Inventory
  1. Orders
  • Orders
    • Create Order
      POST
    • Order Status
      POST
    • Order Fulfillment Detail
      POST
  • Inventory
    • Get Item Inventory
      POST
    • Get Item PIM Data
      POST
  • Schemas
    • Schemas
      • Order Header
      • Order Line
      • Item Inventory
      • Item PIM
  1. Orders

Order Status

POST
https://test.v1.vertexapi.com/Orders/orderstatus
The /orders/orderstatus endpoint provides real-time visibility into the current status of orders submitted through the Vertex API.
By passing your unique order reference or Vertex Sales Order ID, you can retrieve detailed tracking information including fulfillment status, shipment status, and timestamps for each key stage in the order lifecycle. Alternatively, use a date range with a maximum 30-day window.
Tracking number will populate under this endpoint if the order has shipped. Detailed fulfillment data is available from /orders/orderfulfillment
Status Codes:
Pending Approval - Order awaiting financial approval
Pending Fulfillment - Order received, awaiting shipment
Order Picking - Order currently being picked
Order Packed - Order packed, awaiting shipment
Shipped - Order shipped and complete
Contact Account Manager - Order exception, contact your Vertex Account Manager

Request

Authorization
OAuth 2.0
Client Credentials
Add the parameter
Authorization
to Headers，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Token URL: https://auth.v1.vertexapi.com/oauth2/token
Refresh URL: https://auth.v1.vertexapi.com/oauth2/token
or
Body Params application/json

Examples

Responses

🟢200OK
application/json
Success
Body

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://test.v1.vertexapi.com/Orders/orderstatus' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order": "ORDER1234"
    "startDate": null,
    "endDate": null
}'
Response Response Example
[
    {
        "vertexOrder": "SO196999",
        "customerOrder": "ORDER1234",
        "orderDate": "04/18/2025",
        "orderStatus": "Pending Fulfillment",
        "tracking": ""
    }
]
Modified at 2025-09-06 20:40:36
Previous
Create Order
Next
Order Fulfillment Detail
Built with