Data Depot

  • Pages
  • /
  • Dealers
  • /
  • Data Depot
  • /
  • Version 4
  • /
  • API
  • /
  • Order Processing
  • /
  • Orders

Navigation

API News and Updates

Subscribe to stay alert on the API.

Orders

Order can be created and then the status of that order can be retrieved.

Create an Order (Submit Cart)

POST https://api.wps-inc.com/orders

Arguments
po_number string

PO number used when cart was created. Required
Response
order_number string

The unique number assigned to the order.

Order Status

Get a PO with orders.

GET https://api.wps-inc.com/orders/{po_number}

Or get multiple POs with orders.

GET https://api.wps-inc.com/orders

Arguments
from_date YYYYMMDD string

Find orders created on or after this date Required
to_date YYYYMMDD string

Find orders created on or before this date Required
The PO Object
po_number string

PO number used when cart was created.
ship_name string

The shipping name.
ship_address string

The shipping address.
ship_city string

The shipping city.
ship_state string

The shipping state.
ship_zip string

The shipping zip.
order_details array

Each order's details:

  • order_number: The unique number assigned to the order. (string)
  • order_status: The status of the order. (string)
  • invoice_number: The unique number assigned to the invoice. (integer)
  • freight: The cost of freight. (float)
  • misc_charges: The miscellaneous changes. (float)
  • order_total: The total order cost. (float)
  • warehouse: This warehouse fulfilled the order. (string)
  • order_date: The date the order was placed. (string)
  • ship_date: The date the order was shipped. (string)
  • invoice_date: The date the order was invoiced. (string)
  • ship_via: The shipping method code. (string)
  • tracking_numbers: An array of tracking numbers assigned to the order. (array)
  • items: An array of the items for the order. (array)

Possible ship_via Response Types

  • AH2D = FedEx 2-Day (AK/HI only)
  • BEST = Best Method
  • CO5 = OnTrac Ground
  • CPU = Customer Pickup
  • FDXG = Fedex Ground
  • FDXH = Fedex Home Delivery
  • FDXP = Fedex SmartPost > 1lb
  • FDXS = Fedex SmartPost <= 1lb
  • FE1D = Fedex 1 Day
  • FE2D = Fedex 2 Day
  • FLTS = Fleet Street
  • GRND = Ground Delivery
  • GSCP = GSO Ground
  • SPDY = Speedy Metro
  • TRK = Truck
  • UPS = UPS Ground
  • UPSP = UPS SurePost
  • UPSR = UPS Ground Residential
  • UP1D = UPS 1 Day Red
  • UP1W = UPS Saturday Delivery
  • UP2D = UPS 2 Day Blue
  • USFC = USPS 1st Class Mail 1oz to 16oz *ONLY
  • US1C = USPS Priority Mail
  • US4C = USPS Parcel Post
  • 1DAY = 1 Day Air Delivery
  • 2DAY = 2 Day Air Delivery
  • 3DAY = 3 Day Air Delivery

Possible order_status Response Types

  • Invoiced
  • In O/E
  • Shipped
  • Picking
  • B/O
  • Checking