GET
/
v1
/
orders
/
:id
curl --location --request GET 'https://api.stateset.network/v1/order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "1"
}'

{
  "id": "<string>",
  "name": "<string>",
  "number": "<string>",
  "state": "<string>",
  "customerID": "<string>",
  "items": [
    {}
  ],
  "totalAmount": "<string>",
  "paymentStatus": "<string>",
  "shippingStatus": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "metadata": {}
}

Body

id
string

This is the id of the order.

Response

id
string
required

This is the id of the order.

name
string
required

This is the name of the order.

number
string
required

This is the number of the order.

state
string
required

This is the state of the order.

customerID
string
required

This is the customerID of the order.

items
array
required

This is the list of items in the order.

totalAmount
string
required

This is the total amount of the order.

paymentStatus
string
required

This is the payment status of the order.

shippingStatus
string
required

This is the shipping status of the order.

createdAt
string
required

This is the creation timestamp of the order.

updatedAt
string
required

This is the last updated timestamp of the order.

metadata
object
required

This is additional metadata related to the order.

curl --location --request GET 'https://api.stateset.network/v1/order' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "1"
}'

Orders

Orders describes the general data about the orders in Stateset Commerce Network.

The order object

Attributes

NameTypeDescription
idTextUnique identifier for the order
nameTextName of the order
numberTextNumber of the order
stateTextState of the order
customerIDTextCustomer ID of the order
itemsArrayList of items in the order
totalAmountTextTotal amount of the order
paymentStatusTextPayment status of the order
shippingStatusTextShipping status of the order
createdAtDateTimeCreation timestamp of the order
updatedAtDateTimeLast updated timestamp of the order
metadataObjectAdditional metadata related to the order