Skip to main content

Introduction

Orders describe products/devices whose purchase has been initiated, providing details about the transaction, payment status, and fulfillment progress.

ENDPOINTS
     GET   /v1/orders
     GET   /v1/orders/:orderNo
     POST   /v1/orders/validate
     POST   /v1/orders/create

Order Object

Core Parameters


id
A unique identifier randomly generated by our system. Follows the UUID v4 standard.


orderNo
A unique identifier. The value is the number of seconds since January 1, 1970, 00:00:00 UTC (Unix Epoch). Example "1700895067".


status
The status of the order. Possible values are awaiting-payment, payment-confirmed, on-the-way, sellers-shipped, delivered, completed, canceled, refunded, processing.


quantity
The total quantity of items purchased under the order.


products
The number of products purchased.


totalPrice
The total price of the order.


amountPaid
The amount paid by the buyer.


items
A list of all products purchased. An array of items.



Item Object

Core Parameters


id
A unique identifier randomly generated by our system. Follows the UUID v4 standard.


name
The name of the product/device.


quantity
The quantity of the product/device that is part of the order.


price
The unit price of the product in US dollars ($).


total
The total price of all of this product under the order.


properties
An object defining the specific properties of the product. For example, color, brand, storage capacity, etc.


status
The shipment status of the order item.


trackingInformation
An object that contains tracking information of the product if available. Its parameters are slugId, carrier, trackerId, trackingUrl and trackingNumber.