Skip to main content

Orders API

List Orders

GET /api/v1/manager-core/orders

Get all orders with pagination.

Query Parameters:

ParameterTypeRequiredDescription
warehouseintegerNoFilter by warehouse ID (exists:warehouses,id)
customerintegerNoFilter by customer CRM ID (exists:crm_items,id)
fromdateNoStart date
todateNoEnd date
qstringNoSearch query
defaultFiltersbooleanNoUse default filters
orderobjectNoSorting (row, desc)
statusstringNoOrder status
payment_statusstringNoPayment status
delivery_statusstringNoDelivery status
webshopintegerNoWebshop ID
payment_methodsarrayNoPayment method IDs
delivery_methodsarrayNoDelivery method IDs
partnerintegerNoPartner CRM ID

Create Order

POST /api/v1/manager-core/orders

Request Body:

ParameterTypeRequiredValidation
warehouse_idintegerYes*exists:warehouses,id (*required_without:auto_warehouse)
auto_warehousebooleanNoAuto-select warehouse
webshop_idintegerYesexists:webshops,id
payment_methodintegerYesexists:payment_methods,id
country_idintegerYesexists:countries,id
emailstringYesemail
phonestringYesmax:255, min:5
currencystringYesexists:currencies,code
typestringYesmax:1
first_namestringNomax:255, min:1
last_namestringNomax:255, min:1
tax_codestringNomax:255
eu_tax_codestringNomax:255
business_namestringNomax:255, min:1
invoice_post_codestringNomax:40, min:0
invoice_statestringNomax:255, min:0
invoice_areastringNomax:255, min:0
invoice_citystringNomax:255, min:1
invoice_streetstringNomax:255, min:1
invoice_housestringNomax:255, min:1
deliveryobjectNoDelivery address
delivery.country_idintegerConditionalexists:countries,id (required if delivery present)
delivery.post_codestringNomax:40
delivery.statestringNomax:255
delivery.areastringNomax:255
delivery.citystringConditionalmax:255 (required_without:delivery.package_point)
delivery.streetstringConditionalmax:255 (required_without:delivery.package_point)
delivery.housestringConditionalmax:255 (required_without:delivery.package_point)
delivery.package_pointstringConditionalmax:255 (required_without:delivery.house)
itemsarrayYesarray, min:1
discountnumberNogte:0, max:100
free_shippingbooleanNoin:0,1,true,false
preorderbooleanNoin:0,1,true,false
coupon_amountnumberNogte:0
couponstringNomin:2

Get Order

GET /api/v1/manager-core/orders/{id}

Parameters:

  • id (path) - Order ID

Update Order

PUT /api/v1/manager-core/orders/{id}

Request Body:

ParameterTypeRequiredValidation
country_idintegerNoexists:countries,id
webshop_idintegerNo-
warehouse_idintegerNo-
emailstringNoemail
phonestringNomax:255
first_namestringNomax:255
last_namestringNomax:255
tax_codestringNomax:255
eu_tax_codestringNomax:255
business_namestringNomax:255, min:1
invoice_post_codestringNomax:40, min:1
invoice_citystringNomax:255, min:1
invoice_streetstringNomax:255, min:1
invoice_housestringNomax:255, min:1
invoice_statestringNomax:255, min:0
deliveryobjectNo-
tagsmixedNonullable

Update Multiple Orders

PUT /api/v1/manager-core/orders/multiple

Request Body:

ParameterTypeRequiredValidation
idarrayYesrequired, array of integers
tagsarrayNoarray of tag IDs

Get Order Messages

GET /api/v1/manager-core/orders/{id}/messages

Parameters:

  • id (path) - Order ID

Order Products

GET /api/v1/manager-core/orders/products

Query Parameters:

ParameterTypeRequiredDescription
webshopintegerNoWebshop ID
warehouseintegerNoWarehouse ID
has_problembooleanNoFilter by problem status

Order Returns

GET /api/v1/manager-core/orders/returns

Query Parameters:

ParameterTypeRequiredDescription
webshopintegerNoWebshop ID
warehouseintegerNoWarehouse ID

Change Products

POST /api/v1/manager-core/orders/change

Request Body:

ParameterTypeRequiredValidation
order_idintegerYesexists:orders,id
add_itemsarrayNoArray of items to add
remove_itemsarrayNoArray of items to remove
no_deliverybooleanNoin:0,1
discountnumberNomin:0, max:100
preorderbooleanNoin:0,1,true,false
warehouse_idintegerNo-

Add Payment

POST /api/v1/manager-core/orders/payed

Request Body:

ParameterTypeRequiredValidation
order_idintegerConditional*exists:orders,id (*required_without:orders)
payment_methodintegerConditional*exists:payment_methods,id (*required_without:orders)
refund_methodintegerNoexists:return_methods,id
amountnumberConditional*Numeric (*required_without:orders)
ordersarrayConditional*Array of payment objects (*required_without:order_id)
orders.*.order_idintegerNoexists:orders,id
orders.*.payment_methodintegerNoexists:payment_methods,id
orders.*.refund_methodintegerNoexists:return_methods,id
orders.*.amountnumberNoNumeric

Accept Order

POST /api/v1/manager-core/orders/accept

Request Body:

ParameterTypeRequiredValidation
order_idintegerConditional*exists:orders,id (*required_without:orders)
ordersarrayConditional*Array of order IDs (*required_without:order_id)

Deny Order

POST /api/v1/manager-core/orders/deny

Request Body:

ParameterTypeRequiredValidation
order_idintegerConditional*exists:orders,id (*required_without:orders)
ordersarrayConditional*Array of order IDs (*required_without:order_id)
deny_typeintegerYesin:1,2
itemsarrayNoItems to deny

POST /api/v1/manager-core/orders/send-link

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:orders,id

Edit Delivery

POST /api/v1/manager-core/orders/edit-delivery

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:order_deliveries,id
pricenumberNo-
feenumberNo-

Delete Delivery

POST /api/v1/manager-core/orders/delete-delivery

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:order_deliveries,id

Close Dispute

POST /api/v1/manager-core/orders/close-dispute

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:order_packages,id

Accept Dispute

POST /api/v1/manager-core/orders/accept-dispute

Request Body:

ParameterTypeRequiredValidation
idintegerYesexists:order_packages,id

Check Discount

POST /api/v1/manager-core/orders/check-discount

Request Body:

ParameterTypeRequiredValidation
couponstringYesmin:2
country_idintegerConditional*exists:countries,id (*required_without:shop_id)
emailstringConditional*email (*required_without:shop_id)
currencystringConditional*exists:currencies,code (*required_without:shop_id)
itemsarrayNoarray, min:1
shop_idintegerNoexists:shops,id
webshop_idintegerNoexists:webshops,id

Create Parcel

POST /api/v1/manager-core/orders/delivery

Request Body:

ParameterTypeRequiredValidation
order_package_idinteger/arrayYesexists:order_packages,id
packagesintegerNomin:1

Create Manual Parcel

POST /api/v1/manager-core/orders/delivery/manual

Request Body:

ParameterTypeRequiredValidation
order_idintegerYesexists:orders,id
widthnumberNonumeric
heightnumberNonumeric
lengthnumberNonumeric
weightnumberNonumeric
delivery_method_idintegerYesexists:delivery_methods,id
country_idintegerYesexists:countries,id
post_codestringYes-
citystringYes-
streetstringYes-
housestringYes-
valuemixedYes-

Mark Delivery Success

POST /api/v1/manager-core/orders/delivery/success

Request Body:

ParameterTypeRequiredValidation
order_package_idintegerYesexists:order_packages,id

Refuse Delivery

POST /api/v1/manager-core/orders/delivery/refuse

Request Body:

ParameterTypeRequiredValidation
order_package_idintegerYesexists:order_packages,id

Create POS Order

POST /api/v1/manager-core/orders/pos

Request Body:

ParameterTypeRequiredValidation
shop_idintegerYesexists:shops,id
pricemixedYes-
paymentsarrayConditional*(*required_unless:price,0)
payments.*.methodintegerYesexists:payment_methods,id
payments.*.amountnumberYesgte:0
itemsarrayNomin:1
couponstringNo-
receiptMethodintegerNo-
country_idintegerConditionalexists:countries,id (*required_if:receiptMethod,1 or 2)
emailstringConditionalemail (*required_if:receiptMethod,2)
typestringConditionalmax:1 (*required_if:receiptMethod,1 or 2)
first_namestringConditionalmax:255 (*required_if:type,0)
last_namestringConditionalmax:255 (*required_if:type,0)
tax_codestringNomax:255
eu_tax_codestringNomax:255
business_namestringConditionalmax:255, min:1 (*required_if:type,1)
invoice_post_codestringNomax:40
invoice_statestringNomax:255
invoice_areastringNomax:255
invoice_citystringConditionalmax:255 (*required_if:receiptMethod,1 or 2)
invoice_streetstringConditionalmax:255 (*required_if:receiptMethod,1 or 2)
invoice_housestringConditionalmax:255 (*required_if:receiptMethod,1 or 2)

Generate Invoice

POST /api/v1/manager-core/orders/invoice

Request Body:

ParameterTypeRequiredValidation
order_idinteger/arrayYesexists:orders,id

Set Item to Package

POST /api/v1/manager-core/orders/{id}/packaging

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:order_items,id

Set Item Returned

POST /api/v1/manager-core/orders/{id}/returned

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:order_items,id

Cancel Return

POST /api/v1/manager-core/orders/{id}/cancel-return

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:order_items,id

Set Extra Item to Package

POST /api/v1/manager-core/orders/{id}/packaging-extra

Request Body:

ParameterTypeRequiredValidation
itemintegerYesexists:product_variants,id

Edit Prices

POST /api/v1/manager-core/orders/{id}/edit-prices

Request Body:

ParameterTypeRequiredValidation
itemsarrayYes-
items.*.idintegerYesexists:product_variants,id
items.*.pricemixedYes-

Order Export

GET /api/v1/manager-core/orders/export/{exportType}

Parameters:

  • exportType (path) - Export format: xlsx, xls, ods, pdf, csv

Order Problems

List Problem Categories

GET /api/v1/manager-core/orders/problems/categories

Create Problem Category

POST /api/v1/manager-core/orders/problems/categories

Request Body:

ParameterTypeRequiredValidation
namestringYes-

Update Problem Category

PUT /api/v1/manager-core/orders/problems/categories/{id}

Request Body:

ParameterTypeRequiredValidation
namestringYes-

Delete Problem Category

DELETE /api/v1/manager-core/orders/problems/categories/{id}

Create Problem

POST /api/v1/manager-core/orders/problems

Request Body:

ParameterTypeRequiredValidation
order_idintegerYes-
category_idintegerYes-
descriptionstringNo-

Update Problem

PUT /api/v1/manager-core/orders/problems/{id}

Delete Problem

DELETE /api/v1/manager-core/orders/problems/{id}

Problem Categories (Alternative)

List

GET /api/v1/manager-core/orders/problem-categories

Create

POST /api/v1/manager-core/orders/problem-categories

Request Body:

ParameterTypeRequiredValidation
namestringYes-

Update

PUT /api/v1/manager-core/orders/problem-categories/{id}

Request Body:

ParameterTypeRequiredValidation
namestringYes-

Delete

DELETE /api/v1/manager-core/orders/problem-categories/{id}