Create an Order

Draft Order

To create a new Order, you need to create a Draft Order first. The Draft Order is a temporary order that allows you to configure the order details before finalizing it. Once the Draft Order is created, you can proceed to create the actual Order using the Draft Order ID. The Draft Order contains all the necessary information about the order, including the product details, customer information, and measurements. The Draft Order has not yet been finalized and can be modified before creating the actual Order.

API Reference

Create a Draft Order

Creating a Draft Order is the first step in the order process. Please note that the Draft Order is not yet finalized and can be modified before creating the actual Order.

/api/v1/draft-orders

Request parameters

{
  "externalId": "example",
  "shopId": "18ad0215-778d-352d-8f14-959901273e8d"
}

Responses

{
  "id": "18ad0215-778d-352d-8f14-959901273e8d",
  "externalId": "example",
  "shopId": "18ad0215-778d-352d-8f14-959901273e8d"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

Get a Draft Order

This API allows clients to retrieve the details of a specific Draft Order by the Draft Order identifier.

/api/v1/draft-orders/{id}

Request parameters

Responses

{
  "id": "18ad0215-778d-352d-8f14-959901273e8d",
  "externalId": "example",
  "shopId": "18ad0215-778d-352d-8f14-959901273e8d"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

Update a Draft Order

This API allows clients to update the details of a specific Draft Order by the Draft Order identifier.

/api/v1/draft-orders/{id}

Request parameters

{
  "externalId": "example",
  "shopId": "18ad0215-778d-352d-8f14-959901273e8d"
}

Responses

{
  "id": "18ad0215-778d-352d-8f14-959901273e8d",
  "externalId": "example",
  "shopId": "18ad0215-778d-352d-8f14-959901273e8d"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

Delete a Draft Order

This API allows clients to delete a specific Draft Order by the Draft Order identifier.

/api/v1/draft-orders/{id}

Request parameters

Responses

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

Submit an Order

To create an Order, you need to submit the Draft Order.

/api/v1/draft-orders/{id}/submit

Request parameters

Responses

{
  "id": "18ad0215-778d-352d-8f14-959901273e8d",
  "status": "example",
  "submittedAt": "1971-04-26T12:26:06Z",
  "completedAt": "1971-04-26T12:26:06Z",
  "orderId": 96,
  "orderNumber": "example"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

Getting an Order placement progress

This API allows clients to retrieve the progress of placement a specific Order by the Order Request identifier.

/api/v1/order-requests/{id}

Request parameters

Responses

{
  "id": "18ad0215-778d-352d-8f14-959901273e8d",
  "status": "example",
  "submittedAt": "1971-04-26T12:26:06Z",
  "completedAt": "1971-04-26T12:26:06Z",
  "orderId": 96,
  "orderNumber": "example"
}

{
  "type": "example",
  "title": "example",
  "status": 96,
  "detail": "example",
  "instance": "example"
}

Last modified: 30 квітня 2025