Orders
Get Order
This endpoint gets an order.
GET
/
v1
/
orders
/
:id
Body
id
string
This is the id of the order.
Response
id
string
requiredThis is the id of the order.
name
string
requiredThis is the name of the order.
number
string
requiredThis is the number of the order.
source
string
requiredThis is the source of the order.
state
string
requiredThis is the state of the order.
customerID
string
requiredThis is the customerID of the order.
items
array
requiredThis is the list of items in the order.
totalAmount
string
requiredThis is the total amount of the order.
paymentStatus
string
requiredThis is the payment status of the order.
shippingStatus
string
requiredThis is the shipping status of the order.
createdAt
string
requiredThis is the creation timestamp of the order.
updatedAt
string
requiredThis is the last updated timestamp of the order.
metadata
object
requiredThis is additional metadata related to the order.
Orders
Orders describes the general data about the orders in StateSet Commerce Network.
The order object
Attributes
Name | Type | Description |
---|---|---|
id | Text | Unique identifier for the order |
name | Text | Name of the order |
number | Text | Number of the order |
state | Text | State of the order |
customerID | Text | Customer ID of the order |
items | Array | List of items in the order |
totalAmount | Text | Total amount of the order |
paymentStatus | Text | Payment status of the order |
shippingStatus | Text | Shipping status of the order |
createdAt | DateTime | Creation timestamp of the order |
updatedAt | DateTime | Last updated timestamp of the order |
metadata | Object | Additional metadata related to the order |