circle-check
Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
search
Visit our websiteAPI Docs

Order

Order

hashtag
Get Order by order uid

get
/tenants/{tenantUid}/orders/{orderUid}

Get order by order uid

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
Responses
get
/tenants/{tenantUid}/orders/{orderUid}
200

Example response

hashtag
List orders

get
/tenants/{tenantUid}/stores/{storeUid}/orders

List all orders.

The query parameter orderStatus can not be used in combination with orderOrderState, orderSettleState or orderDeliveryState.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
orderExternalOrderNumberstringOptional

External reference to a orderUid.

orderExternalVoucherNumberstringOptional

External reference to a voucher id.

orderCustomerUidstringOptional

Reference to a Customer uid.

Pattern: ^[A-Za-z0-9-_]+
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
orderHandlingUidsstring[]Optional

Reference to a handling uid.

orderSettledAtFromstring · date-timeOptional

Filter by settled at from a specific date

orderSettledAtTostring · date-timeOptional

Filter by settled at to a specific date

orderCreatedAtFromstring · date-timeOptional

Filter by created at from a specific date

orderCreatedAtTostring · date-timeOptional

Filter by created at to a specific date

orderTillUidstringOptional

Reference to a till uid.

Pattern: ^[A-Za-z0-9-_]+
orderTenantUserUidsstring[]Optional

Reference to a tenantUserUid.

Responses
get
/tenants/{tenantUid}/stores/{storeUid}/orders
200

Example response

hashtag
Create a new order

post
/tenants/{tenantUid}/stores/{storeUid}/orders

Create a new order.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
and
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders
200

Example response

hashtag
Import new order from extern source

post
/tenants/{tenantUid}/stores/{storeUid}/orders/import

Import new order from extern source. Complete order with lines and possibly settlements. sellerDisplayName can be set if an integrationToken is used. If no integrationToken and sellerDisplayName is set, an error is returned.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body

Schema for creating a complete order in one request.

createdAtstring · date-time · nullableRequired
customerUidstringOptionalPattern: ^[A-Za-z0-9-_]*
customerContactUidstringOptionalPattern: ^[A-Za-z0-9-_]*
externalOrderNumberstringOptional
externalVoucherNumberstringOptional
notestringOptional
typestring · enumRequiredPossible values:
systemOriginstringOptional
validUntilstring · date-time · nullableRequired
vatFreebooleanRequired
vatPrintstring · enumOptional
ENUM Description
SUM Print as a part of orderlines.
SEPARATE Print as a separate field.
Possible values:
orderUidstringOptionalPattern: ^[A-Za-z0-9-_]+
tenantUserDisplayNamestringOptional
handlingUidsstring[]Optional
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/import
200

Example response

hashtag
Search for order

post
/tenants/{tenantUid}/stores/{storeUid}/orders/search

The field orderStatuses can not be used in combination with orderStates, settleStates or deliveryStates.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Body

Search for orders.

Only one of the keys in the search object will be used in a search.

If more than one key is supplied the keys will be used in the priorty of how they appear in the object. Example: query will be used first if it is supplied, if it is not supplied the customer key will be used, and so on.

An empty string will be ignored, and handeled as if the key did not exist in the payload.

Fuzzy search means that it will try to find words that contains the query string that is supplied. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", etc ..

customerQuerystringOptional

Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.

customerUidstringOptionalPattern: ^[A-Za-z0-9-_]+
fromDateTimestring · date-timeOptional
createdAtFromstring · date-timeOptional
settledAtFromstring · date-timeOptional
lastModifiedAtFromstring · date-timeOptional
orderNumberstringOptional

Search for an order with a specific ordernumber. This is an exact lookup

productSkustringOptional

Search for orders containing the product. This must be a SKU and is an exact lookup.

querystringOptional

General query string. Use to search for orders where the server decided the query conditions. This is a fuzzy search.

toDateTimestring · date-timeOptional
createdAtTostring · date-timeOptional
settledAtTostring · date-timeOptional
lastModifiedAtTostring · date-timeOptional
tenantUserUidsstring[]Optional
orderHandlingUidsstring[]Optional
productUidsstring[]Optional
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/search
200

Example response

hashtag
Update sales order reservations

post
/tenants/{tenantUid}/orders/reservations

Set reservationType on order items to be reserved on a warehouse or a purchaseorder.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
uidstringRequired

The uid must be warehouseUid if the reservationType is WAREHOUSE and purchaseOrderItemUid if it is PURCHASEORDER

Pattern: ^[A-Za-z0-9-_]+
reservationTypestring · enumRequiredPossible values:
Responses
chevron-right
204

No Content

No content
post
/tenants/{tenantUid}/orders/reservations
204

No Content

No content

hashtag
Search for orders in all stores on tenant

post
/tenants/{tenantUid}/orders/search

Optionally narrow down the search to order in given stores and organizatons.

The field orderStatuses can not be used in combination with the fields orderStates, settleStates or deliveryStates.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Body

Search for orders in all stores on tenant.

An empty string will be ignored, and handled as if the key did not exist in the payload.

Fuzzy search means that it will try to find words that contains the query string that is supplied. The search is case-insensitive. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", [email protected], etc ..

storeUidsstring[]Optional
organizationUidsstring[]Optional
customerQuerystringOptional

Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.

customerUidstringOptionalPattern: ^[A-Za-z0-9-_]+
fromDateTimestring · date-timeOptionalDeprecated
createdAtFromstring · date-timeOptional
settledAtFromstring · date-timeOptional
lastModifiedAtFromstring · date-timeOptional
orderNumberstringOptional

Search for an order with a specific ordernumber. This is an exact lookup

externalOrderNumberstringOptional

Search for an order with a specific externalOrderNumber. This is an exact lookup

externalVoucherNumberstringOptional

Search for an order with a specific externalVouchermber. This is an exact lookup

productSkustringOptional

Search for orders containing the product. This must be a SKU and is an exact lookup.

toDateTimestring · date-timeOptionalDeprecated
createdAtTostring · date-timeOptional
settledAtTostring · date-timeOptional
lastModifiedAtTostring · date-timeOptional
tenantUserUidsstring[]Optional
orderHandlingUidsstring[]Optional
deliverFromStoreUidsstring[]Optional
querystringOptional

General fuzzy search.

productUidsstring[]Optional
Responses
post
/tenants/{tenantUid}/orders/search
200

Example response

hashtag
Get order details

get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}

Get order details. This will return a complete order object.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}
200

Example response

hashtag
Order Operations

post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}

Order Operations

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
operationstring · enumRequired
ENUM Description
RECALCULATE_SETTLEMENTS Do a sum of settlements on order and calculate the settle_state on order
RECALCULATE_COSTPRICES Retreive updated costprices on the order linse of an order. Can only be done when order state = PARKED
Possible values:
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}
200

Example response

hashtag
Update order details

put
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}

Update order details.

Order details can only be updated when orderState = OPEN and settleState != COMPLETE

Exception:

externalOrderNumber and externalVoucherNumber can be changed when orderState = COMPLETE

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
customerUidstringOptionalPattern: ^[A-Za-z0-9-_]*
customerContactUidstringOptionalPattern: ^[A-Za-z0-9-_]*
deviceIdentifierstringOptional
externalOrderNumberstringOptional
externalVoucherNumberstringOptional
invoiceCustomerAddressUidstringOptionalPattern: ^[A-Za-z0-9-_]+
notestringOptional

Note visible on the receipt.

typestring · enumOptionalPossible values:
validUntilstring · date-timeOptional
vatFreebooleanOptional
vatPrintstring · enumOptional
ENUM Description
SUM Print as a part of orderlines.
SEPARATE Print as a separate field.
Possible values:
Responses
put
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}
200

Example response

hashtag
Delete an order

delete
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}

Delete an order.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Responses
chevron-right
204

No Content

No content
delete
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}
204

No Content

No content

hashtag
Create new order item

post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items

Creates a new item on an order.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
Body
discountReasonCodestringOptional
externalIdstringOptional

External reference to order line

itemDiscountAmountintegerOptional
itemDiscountPercentageintegerOptional

Used to calculate itemDiscountAmount.

itemPriceintegerOptional
notestringOptional
productUidstringRequiredPattern: ^[A-Za-z0-9-_]+
quantityOrderedintegerOptional
reserveStockbooleanOptionalDeprecated

Set this to true to only resevere the stock from the warehouse when the order is settled.

Default: false
deliveryUidstringOptionalPattern: ^[A-Za-z0-9-_]+
returnReasonCodestringOptional
serialnumberstringOptional
skustringOptional

Product SKU

warehouseUidstringOptionalPattern: ^[A-Za-z0-9-_]*
purchaseOrderItemUidstringOptionalPattern: ^[A-Za-z0-9-_]*
orderItemUidstringOptionalPattern: ^[A-Za-z0-9-_]*
reservationTypestring · enumOptionalPossible values:
sortOrderintegerOptional
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items
200

Example response

hashtag
Get available payment methods for an order

get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/payment-methods

Get available payment methods for an order

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
Responses
get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/payment-methods
200

Example response

hashtag
Update order item details

put
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}

Update details for an item on an order. Partial updates are allowed. Order item details can only be updated when order.orderState = OPEN and order.settleState != COMPLETE

Exception:

externalId can be changed when orderState = COMPLETE

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
orderItemUidstringRequired

Reference to an order item on an order.

Pattern: ^[A-Za-z0-9-_]+
Body
discountReasonCodestringOptional
externalIdstringOptional

External reference to order line

itemDiscountAmountintegerOptional
itemDiscountPercentageintegerOptional

Used to calculate itemDiscountAmount.

itemPriceintegerOptional
notestringOptional
quantityOrderedintegerOptional
reserveStockbooleanOptionalDeprecated

Set this to true to only resevere the stock from the warehouse when the order is settled.

deliveryUidstringOptionalPattern: ^[A-Za-z0-9-_]*
returnReasonCodestringOptional
serialnumberstringOptional
warehouseUidstringOptionalPattern: ^[A-Za-z0-9-_]*
reservationTypestring · enumOptionalPossible values:
purchaseOrderItemUidstringOptionalPattern: ^[A-Za-z0-9-_]*
sortOrderintegerOptional
Responses
put
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}
200

Example response

hashtag
Delete order item

delete
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}

Delete an item on an order.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
orderItemUidstringRequired

Reference to an order item on an order.

Pattern: ^[A-Za-z0-9-_]+
Responses
delete
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}
200

Example response

hashtag
List addons for order item

get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/addons

List addons for order item

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
orderItemUidstringRequired

Reference to an order item on an order.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
productLinkTypestring · enumOptional

Reference to a productLinkType.

Possible values:
Responses
get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/items/{orderItemUid}/addons
200

Example response

hashtag
Print order

post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/print

Print order Content and form is decided by type. orderItemUids is omitted when type is RECEIPT

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
typestring · enum · min: 1Required
ENUM Description
RECEIPT Print sales receipt
EXCHANGENOTE Print exchange note
GIFTCARD Print giftcard barcode
PICKUP Print a pickup label/note
Possible values:
printerUidstringOptional

The printer to send the print to

Pattern: ^[A-Za-z0-9-_]+
orderItemUidsstring[]Optional
exchangenoteValidUntilstring · dateOptional

Only valid for type EXCHANGENOTE. Sets a date that the exchange note is valid until. If not set, exchangeNoteValidUntil is calculated from the store's exchangeNoteValidDays setting. Stored on all orderItemUids in request, usually only one item.

Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/print
No content

hashtag
Create order pdf

post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pdf

Create an order pdf. Content and form is decided by type.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
typestring · enum · min: 1Required
ENUM Description
RECEIPT Make pdf file from sales receipt
Possible values:
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/pdf

hashtag
Send order content by email

post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/email

Send order content by email.

Content and form is decided by type. orderItemUids is omitted when type is RECEIPT

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
typestring · enum · min: 1Required
ENUM Description
RECEIPT Send sales receipt as email
GIFTCARD Send giftcard as email
Possible values:
emailstringRequired
orderItemUidsstring[]Optional
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/email
No content

hashtag
Change order status

put
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/status

Set status on an order. Limited to Open and Parked.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
Body
statusstring · enumRequired
ENUM Description
OPEN Set order in state open, to be able to edit it.
PARKED Set order in state parked.
Possible values:
Responses
put
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/status
200

Example response

hashtag
List order additional notes

get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes

List additional notes, or comments, on orders.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
get
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes
200

Example response

hashtag
Create order additional notes

post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes

Create additional notes, or comments, on orders. Define wether a notification is to be sent to the customer. The notification may be on email or SMS or both.

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
Body
notestringRequired
orderAdditionalNoteUidstringOptionalPattern: ^[A-Za-z0-9-_]*
Responses
post
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes
201

Example response

hashtag
Delete order additional notes

delete
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes/{orderAdditionalNoteUid}

Delete order additional notes

Authorizations
AuthorizationstringRequired

Accesstoken recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+
orderUidstringRequired

Reference to an Order.

Pattern: ^[A-Za-z0-9-_]+
orderAdditionalNoteUidstringRequired

Reference to an orderAdditionalNote

Pattern: ^[A-Za-z0-9-_]+
Responses
chevron-right
204

No Content

No content
delete
/tenants/{tenantUid}/stores/{storeUid}/orders/{orderUid}/additional-notes/{orderAdditionalNoteUid}
204

No Content

No content
PreviousOrganizationNextOrderDelivery

Last updated

Was this helpful?