797 results
Sorted by relevance
API / Orders
View Order Endpoint
Structure
Order
Name
Type
Description
reference
string
The unique reference for the order
status
object
The Order Status of the order (
null if none)
customer
object
The Customer of the order (
null if none)
email
string
The email of the customer that placed t...
API / Orders
Create Order Endpoint
Structure
Order
Name
Type
Description
Required
id
int
The id for the order
No
reference
string
The unique reference for the order
Yes
status_id
int
The status id of the order, can also be resolved from
state
If
ordered_at is not null
state
string
Alternative...
API / Orders
Flag Order Endpoints
Examples
Adding a Flag
Request
POST /api/orders/{id|reference}/flags/{id|name}
Response
{
"order": {
"id": 1
},
"flag": {
"id": 1
}
}
Removing a Flag
Request
DELETE /api/orders/{id|reference}/flags/{id|name}
Response
204 No Cont...
API / Orders
Order Comments Endpoint
Structure
Name
Type
Description
Required
id
int
The id for the comment
No
admin
int|string
The id or email of the admin
No
message
string
The comment message
Yes
customer_facing
boolean
Whether the comment is customer facing (default:
false)
No
created_at
tim...
API
Fulfillments
API / Fulfillments
Create Fulfillment Endpoint
Structure
Fulfillment
Name
Type
Description
Required
id
int
The id for the fulfillment
No
reference
string
The reference for the fulfillment
No
state
string
The state of the fulfillment (defaults to method's default if not passed)
No
method
int| string
The ful...
API / Fulfillments
Delete Fulfillment Endpoint
Example Request
DELETE /api/orders/{id|reference}/fulfillments/{id|reference}
Example Response
204 No Content
API
Order Statuses
API / Order Statuses
Order Status Index Endpoint
Structure
See
View Order Status Endpoint for the structure of the order status payload inside the
data array.
Example Request
GET /api/order-statuses?per_page=2
Example Response
{
"current_page": 1,
"data": [
//
],
"first_page_url": "...
API / Order Statuses
View Order Status Endpoint
Structure
Order Status
Name
Type
Description
id
int
The id of the order status
name
string
The name of the order status
state
string
The state of the order status
group
object
The Group of the order status
Order Status Group
Name
Type
Description
id
int
The id...
API
Products
API
Variants
API
Manufacturers
API
Attribute Groups
API
Attributes
API
Categories
API
Tag Groups
API
Tags