Orders

Retrieve a order

Changed on

Retrieve details of a order.

get/orders/{order_id}

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/orders/{order_id}
  • Auth: HTTP bearer

Path parameters

order_idstring uuid required
Example:f8dd4c21-b38d-4e39-8e20-2b97e79f0db1

Query parameters

include_outlets_data'true' | 'false'

Response

Order retrieved successfully

idstring uuid required
profile_idstring uuid nullable required
client_idstring uuid nullable required
checkout_by_idstring uuid nullable required
team_idstring uuid nullable required
totalnumber nullable required
subtotalnumber nullable required
processing_feenumber nullable required
discountnumber nullable required
credits_appliednumber nullable required
couponstring nullable required
status'CREATED' | 'PAID' | 'CANCELLED' required
reference_numberstring nullable required
external_reference_numberstring nullable required
is_guest_orderboolean required
payment_status'NOT_STARTED' | 'OPEN' | 'PROCESSING' | 'FAILED' | 'EXPIRED' | 'PAID' required
namestring nullable
checkout_linkstring nullable required

Guest checkout link. Only present when the order is not yet paid.

Example response

{
  "total": 121.09,
  "subtotal": 46.9,
  "processing_fee": 915.35,
  "discount": 12.79,
  "coupon": "AMAZING50",
  "status": "CREATED",
  "reference_number": "PC12345678",
  "external_reference_number": "PC12345678",
  "payment_status": "NOT_STARTED",
  "line_items": [
    {
      "quantity": 1,
      "price": 24.69
    }
  ],
  "checkout_link": "https://app.presscart.com/orders/checkout/PC12345678"
}

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status