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

Create Order

POST
https://test.v1.vertexapi.com/Orders
The /orders endpoint allows you to submit new orders directly to the Vertex API for processing and fulfillment.
Each order must include a valid VertexSKU obtained from the /inventory endpoint to ensure accurate product identification.
The API supports key order fields such as shipping details, customer references, and additional metadata for tracking and integration purposes.
If configured, the optional CustomerKey header can be used to route orders against dedicated, customer-owned inventory, or sub-customer processing.
Required fields include:
Customer order reference
End user order number
Shipping method and complete shipping address
Order date
At least one line item with VertexSKU and quantity
Supported Ship Methods: UPSG (UPS Ground), UPSNDA (UPS Next Day Air), UPSNDAS (UPS Next Day Air Saver), FDXNDAS (FedEx Standard Overnight), FDXNDAP (FedEx Priority Overnight), F2DA (FedEx 2 Day), F2DA1R (FedEx 2 Day One Rate), FDXS (FedEx Express Saver), FDXG (FedEx Ground), USPS (USPS Priority Mail)
Upon successful submission, orders will be processed through the Vertex API's fulfillment system and can be tracked using the /orders/orderstatus and /orders/orderfulfillment endpoints.

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
Header Params

Body Params application/json

Examples

Responses

🟢200OK
Ok
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.v1.vertexapi.com/Orders' \
--header 'CustomerKey;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "custOrder": "Order1234",
    "orderType": "New",
    "endUserOrderNumber": "EndCustomerPO",
    "shipMethod": "UPSG",
    "orderDate": "2025-05-01",
    "shipTo": "Vertex Wireless",
    "shipAdd1": "500 Wegner Drive",
    "shipAttention": "API User",
    "shipCity": "West Chicago",
    "shipState": "IL",
    "shipZip": "60185",
    "shipPhone": "6302936300",
    "countryCode": "US",
    "items": [
        {
            "lineNum": 1,
            "vertexPart": "SA-PARTTEST-A001-GEGE",
            "quantity": 1,
            "customerPart": "YourPartNumber",
            "price": 499.99,
            "bidNumber": "SPA-Detail-123"
        }
    ]
}'
Modified at 2025-09-15 13:14:59
Next
Order Status
Built with