Skip to content

Orders Endpoint

TIP

Refer to products page for Base URL

* List Orders

Endpoint: GET

sell/orders

Request Headers

AuthorizationValueDescriptionRequired
Bearer*****Firebase access token✔️

Parameters

Not requires

Sample Response

{
  "count": 12,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "bcc0ad7f-2b71-4021-816a-efd7f8ca5254",
      "product": {
          "name": "Turkey Muslim Maxi Dress - Black",
          "images": [
              "http://127.0.0.1:8000/media/products/2023-07-25/252903747_410898053822974_7209345822968452321_n.jpg"
          ]
      },
      "orderId": {
          "userName": "Samuel Kofi Gyimah",
          "deliveryType": "Collection",
          "orderNumber": "#AZN1UPOPDDBY"
      },
      "dateCreated": "2023-08-05T10:38:08.255453Z",
      "size": "43",
      "color": {
          "code": "#123",
          "name": "red"
      },
      "quantity": 2,
      "price": "67.32",
      "status": "On the way"
    }
  ]
}

* Update Order ~ Status

Endpoint: PATCH | PUT

sell/orders/pk

Request Headers

AuthorizationValueDescriptionRequired
Bearer********Firebase access token✔️

Parameters

NameTypeDescriptionRequired
pkstringorder id✔️

Sample Payload

 {
  "status": "On the way"
}

Sample Response

{
  "id": "8aaa8580-ceaa-43b9-be4b-7dbd0c2df044",
  "orderNumber": "#PCM1SGV851H5",
  "size": "43",
  "color": {
    "code": "#123",
    "name": "red"
  },
  "quantity": 1,
  "salePrice": "887.50",
  "deliveryPrice": "10.00",
  "status": "On the way",
  "dateCreated": "2023-05-30T16:15:56.992253Z",
  "dateUpdated": "2023-06-01T08:21:08.556854Z",
  "product": "f0488db4-b76c-4ffb-9fdb-d0ef91a47689",
  "store": "0e91a1fb-a8e9-4bea-80db-7f745cfb112c",
  "orderId": "4a0d2580-4f42-4b24-915a-63fd67cca947"
}

Released under the MIT License.