Sign in

v1

latestOpenAPI 3.0.12026-07-24204977.5 KB
Orders

Get order status

get/order/{uuid}

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' required

(NOT LIVE YET) Customer’s payment type. Populated for completed and refunded orders only.

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": "PAYLATER"
}