SHshopback
Orders

Get order details

Changed on
get/order/{uuid}/details

Request

Path parameters

uuidstring required

order uuid

Headers

Authorizationstring required

Authorization

X-ShopBack-Idempotent-Idstring
Example:faa5e09a-8cf3-43f7-8309-d94deb426e66

Idempotent Id for the request. If this is absent, every request will be treated as unique and will be processed as such. (This is optional for now, but will be made required in the future)

Response

successful operation

idinteger required

Order ID

uuidstring required

Randomly generated order uuid

createdAtstring date-time required

Order creation time

status'INITIATED' | 'APPROVED' | 'CANCELLED' | 'REJECTED' | 'REFUNDED' required

Order status provided to the merchant

orderType'INSTORE' | 'ONLINE' required

Order type

initialAmountnumber required

Initial total amount of order

totalAmountnumber required

Total amount of order, includes all items

originalAmountnumber required

Pre discount amount of order, includes all items

taxAmountnumber

Total tax for the order

voucherCodestring

Any voucher code to be applied on order

currencystring required

Currency of the order

merchantRefstring required
consumerEmailstring required

Consumer's email

shippingMethod'NORMAL' | 'EXPRESS' | 'PICKUP' | 'FREE' | 'MERCHANT_SPECIFIED'

Shipping method preferred for order

shippingAmountnumber

shipping amount

paymentType'PAYLATER' | 'PAY'

Customer’s payment type. Populated for approved and refunded orders only. Returned only for enabled outlets.

failureReasonstring nullable

Failure reason for rejected orders. Returned only for enabled outlets.

ccdOrderReferencestring

ShopBack's order reference in format YYMMDD-NNNN-AAAA. Returned only for enabled outlets.

Example response

{
  "id": 12345,
  "uuid": "4d33044e-f182-4079-aee4-faa46fbf334e",
  "createdAt": "2019-01-28T10:56:28.995Z",
  "status": "INITIATED",
  "orderType": "ONLINE",
  "voucherCode": "FLAT50",
  "currency": "SGD",
  "consumerEmail": "bruce.willis@shopback.com",
  "shippingAddress": {
    "uuid": "52f92822-9f76-11e8-8b75-c308de44b6c4",
    "createdAt": "2019-01-28T10:56:28.995Z",
    "line1": "Blk 35 Mandalay Road",
    "line2": "# 13-37 Mandalay Towers",
    "suburb": "SINGAPORE",
    "postcode": "308215",
    "countryCode": "SG",
    "district": "01",
    "generalDistrictLocation": "Telok Blangah, Harbourfront",
    "city": "Singapore",
    "state": "Singapore"
  },
  "shippingMethod": "NORMAL",
  "orderItems": [
    {
      "name": "radioactive man comic book",
      "sku": "93847598347",
      "description": "radioactive man comic book"
    }
  ],
  "paymentType": "PAY",
  "failureReason": "INSUFFICIENT_FUNDS",
  "ccdOrderReference": "220816-1655-IZFA"
}

Changes