ORDER API

Process and manage your orders


  • GET /api/order

    Retrieves a list of all the orders

  • GET /api/order/{id}

    Retrieves a specific order

  • POST /api/order

    Creates a new order


id

The ID or unique identifier of the order

"id": 1
po_number

Purchase order number

"po_number": "PO0000000001"
tracking_number

Tracking number

"tracking_number": "547564789798789"
status

---

"status": "---"
name

Customer's name

"name": "John Doe"
email

Customer's email address

"email": "johndoe@email.com"
phone

Customer's phone number

"phone": "(999) 999-9999"
address_line_1

Customer's address (line 1)

"address_line_1": "1F 111, Block 10"
address_line_2

Customer's address (line 2)

"address_line_2": "LongJun Industrial Zone, Dalang"
zip

Customer's Zip/Postal Code

"zip": "511700"
city

Customer's city

"city": "Shenzhen"
province

Customer's province

"province": "Guangdong"
country

Customer's country

"country": "China"
remarks

Additional remarks

"remarks": "Deliver on time"
order_date

Additional remarks

"order_date": "01/01/2020"
processed_date

Additional remarks

"processed_date": "01/02/2020"
closed_date

Additional remarks

"closed_date": "01/03/2020"
cancelled_date

Additional remarks

"cancelled_date": "01/04/2020"
cancel_reason

Additional remarks

"cancel_reason": "---"
subtotal_price

Additional remarks

"subtotal_price": "500"
shipping_cost

Additional remarks

"shipping_cost": "100"
total_tax

Additional remarks

"total_tax": "15"
total_discounts

Additional remarks

"total_discounts": "0"
total_price

Additional remarks

"total_price": "615"
order_items

List of items

"order_items": [

{

"id": 15,

"order_id": 5,

"product_variant_id": 1,

"quantity": 15,

"price": "0.02",

"discount": "0.00",

"fulfillment_status": "Pending",

"created_at": "2019-03-26 12:38:29",

}

]

  • id: ID of the order line item
  • order_id: ID of the order
  • product_variant_id: ID of the product variant
  • quantity: Quantity of the product variant that is being ordered
  • price: Price of the product variant
  • discount: Discount for the product variant
  • fulfillment_status: Status of the order line item
  • created_at: Date and time that the order line item was created
  • updated_at: Date and time that the order line item was last updated

Retrieving all the orders

Header

  • Authorization: Bearer {Your-API-Token}
  • Accept: application/json
GET /api/order

Retrieving a specific order

Header

  • Authorization: Bearer {Your-API-Token}
  • Accept: application/json
GET /api/order/{order}

Retrieving a specific product

Header

  • Authorization: Bearer {Your-API-Token}
  • Accept: application/json
POST /api/order
{
  "name": "John Doe",
  "email": "johndoe@email.com",
  "phone": "(999) 999-9999",
  "address_line_1": "1F 111, Block 10",
  "address_line_2": "LongJun Industrial Zone, Dalang",
  "zip": "511700",
  "city": "Shenzhen",
  "province": "Guangdong",
  "country": "China",
  "remarks": "---",
  "order_date": "",
  "processed_date": "01/01/2020",
  "closed_date": "01/02/2020",
  "cancelled_date": "01/03/2020",
  "cancel_reason": "---",
  "subtotal_price": "500",
  "shipping_cost": "100",
  "total_tax": "50",
  "total_discounts": "0",
  "total_price": "650",
  "order_items": [
{
  "id": 1, "quantity": 10
  },
{  "id": 2, "quantity": 5
  },
{
  "id": 3, "quantity": 15
  }
  ]
 }