API Reference

Customer Orders

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Customer Orders

CustomerOrderCreateCustomerOrdersResponse CustomerOrders.CreateCustomerOrders(CustomerOrderCreateCustomerOrdersParamsparameters, CancellationTokencancellationToken = default)

POST/api/v2/public/stores/{store_number}/orders/customerorders

Creates customer orders and their lines for one store. Every product_number must already exist in the catalogue; an unknown one rejects the whole request. Setting flush to true first deletes all existing customer orders and lines for the stores in the request, so only use it when you are sending the complete set.

ParametersExpand Collapse

CustomerOrderCreateCustomerOrdersParams parameters

required string storeNumber

Path param: The store the orders are for.

Boolean flush

Query param: Deletes all existing customer orders for the stores in the request before inserting.

IReadOnlyList<Order>? orders

Body param

required string OrderNumber

minLength1

string? CustomerCity

string? CustomerCountry

string? CustomerEmail

string? CustomerName

string? CustomerNumber

string? CustomerPhone

string? CustomerStreet

string? CustomerZipcode

string? DeliveryCity

string? DeliveryCountry

string? DeliveryStreet

string? DeliveryZipcode

string? Description

string? FileName

Boolean? IsActive

Boolean IsPicked

Boolean? IsRejected

string? OrderComment

IReadOnlyList<OrderLine>? OrderLines

required Long LineNumber

formatint64

required string ProductNumber

minLength1

required Double Quantity

formatdouble

string? Barcode

DateTimeOffset DeliveryDate

formatdate-time

string? Description

string? FullFillmentStatus

Boolean IsPicked

Boolean IsPickedFromWarehouse

DateTimeOffset OrderingDatetime

formatdate-time

Double PickedQuantity

formatdouble

IReadOnlyList<string>? PickingStockPoolArray

DateTimeOffset? PickupDate

formatdate-time

string? PreferredLocationCode

Double Price

formatdouble

string? Reference

Int StockPool

formatint32

string? OrderType

string? OrderTypeCode

string? OrderTypeDescription

string? Reference

string? SalesOrderID

Int? StatusID

formatint32

ReturnsExpand Collapse

class CustomerOrderCreateCustomerOrdersResponse:

Standard success response returned by mutation endpoints.

required Boolean Success

Indicates whether the operation completed successfully.

string? Data

Optional data payload returned by the operation.

string? Message

Human-readable message describing the result.

Create Customer Orders

C#

HTTP

C#

Python

TypeScript

CustomerOrderCreateCustomerOrdersParams parameters = new()
{
    StoreNumber = "store_number"
};

var response = await client.CustomerOrders.CreateCustomerOrders(parameters);

Console.WriteLine(response);

200 example

401 example

500 example

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

200 example

401 example

500 example

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}