POST api/Order

Create Order

Request Information

URI Parameters

None.

Body Parameters

Order data

Order
NameDescriptionTypeAdditional information
Order_No

Customer Order Number

string

Required

Order_Date

Order Create Date

date

None.

FOB

State (two words) API : api/Locations/DC

string

Required

Warehouse_ID

Capbarbell - Warehouse ID (ex: NJ = 25601) API : api/Locations/Warehouse

string

Required

Type

Order Type (default : Outbound) - 0 : Outbound - 1 : Inbound

OrderType

None.

Items

List of Product

Collection of OrderItem

Required

ShipTo

Ship to information

OrderShipTo

Required

TrackingNumber

Tracking #

string

None.

CarrierNumber

Carrier #

string

None.

Status

Order Status

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Order_No": "sample string 1",
  "Order_Date": "2025-12-05T03:49:20.634146-06:00",
  "FOB": "sample string 2",
  "Warehouse_ID": "sample string 3",
  "Type": 0,
  "Items": [
    {
      "Product_ID": "sample string 1",
      "Quantity": 2
    },
    {
      "Product_ID": "sample string 1",
      "Quantity": 2
    }
  ],
  "ShipTo": {
    "Recipient": "sample string 1",
    "Contact": "sample string 2",
    "Telephone": "sample string 3",
    "Fax": "sample string 4",
    "Email": "sample string 5",
    "Country": "sample string 6",
    "State": "sample string 7",
    "City": "sample string 8",
    "Zip": "sample string 9",
    "Address1": "sample string 10",
    "Address2": "sample string 11"
  },
  "TrackingNumber": "sample string 4",
  "CarrierNumber": "sample string 5",
  "Status": "sample string 6"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Order'.

 
Response information

Resource Description

Order
NameDescriptionTypeAdditional information
Order_No

Customer Order Number

string

Required

Order_Date

Order Create Date

date

None.

FOB

State (two words) API : api/Locations/DC

string

Required

Warehouse_ID

Capbarbell - Warehouse ID (ex: NJ = 25601) API : api/Locations/Warehouse

string

Required

Type

Order Type (default : Outbound) - 0 : Outbound - 1 : Inbound

OrderType

None.

Items

List of Product

Collection of OrderItem

Required

ShipTo

Ship to information

OrderShipTo

Required

TrackingNumber

Tracking #

string

None.

CarrierNumber

Carrier #

string

None.

Status

Order Status

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Order_No": "sample string 1",
  "Order_Date": "2025-12-05T03:49:20.7315003-06:00",
  "FOB": "sample string 2",
  "Warehouse_ID": "sample string 3",
  "Type": 0,
  "Items": [
    {
      "Product_ID": "sample string 1",
      "Quantity": 2
    },
    {
      "Product_ID": "sample string 1",
      "Quantity": 2
    }
  ],
  "ShipTo": {
    "Recipient": "sample string 1",
    "Contact": "sample string 2",
    "Telephone": "sample string 3",
    "Fax": "sample string 4",
    "Email": "sample string 5",
    "Country": "sample string 6",
    "State": "sample string 7",
    "City": "sample string 8",
    "Zip": "sample string 9",
    "Address1": "sample string 10",
    "Address2": "sample string 11"
  },
  "TrackingNumber": "sample string 4",
  "CarrierNumber": "sample string 5",
  "Status": "sample string 6"
}