SHshopback
Orders

Get order status

Changed on
get/order/{uuid}

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

uuidstring required

Randomly generated order uuid

orderUuidstring required

Randomly generated order uuid. Same as 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

merchantRefstring required

Merchant's Order Id

merchantOrderIdstring required

Merchant's Order Id. Same as merchantRef

consumerEmailstring required

Consumer's email

paymentMethod'PAYLATER' | 'PAY'

Customer’s payment method. Populated for completed and refunded orders only. This field is deprecated.

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

{
  "uuid": "4d33044e-f182-4079-aee4-faa46fbf334e",
  "orderUuid": "4d33044e-f182-4079-aee4-faa46fbf334e",
  "createdAt": "2019-01-28T10:56:28.995Z",
  "status": "INITIATED",
  "orderType": "ONLINE",
  "merchantRef": "#2020-82445",
  "merchantOrderId": "#2020-82445",
  "consumerEmail": "bruce.willis@shopback.com",
  "paymentMethod": "PAYLATER",
  "paymentType": "PAY",
  "failureReason": "INSUFFICIENT_FUNDS",
  "ccdOrderReference": "220816-1655-IZFA"
}

Changes

  • a3ac503a275eRevision changes
    • breaking

      the response property became optional for the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status