> For the complete documentation index, see [llms.txt](https://dev.skladon.com/main/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.skladon.com/main/v2/integration/api/orders.md).

# Orders

## POST /orders/filter

> Filter orders

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"OrdersGridResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/OrdersGrid"}},"required":["statusCode","message"]},"OrdersGrid":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Orders"},"request":{"$ref":"#/components/schemas/GridRequest"},"totalCount":{"type":"number"}}},"Orders":{"type":"array","items":{"$ref":"#/components/schemas/OrderWithoutProduct"}},"OrderWithoutProduct":{"type":"object","properties":{"id":{"type":"number"},"status":{"type":"string","enum":["inProcess","lost","received","processing","processed","onTheWay","delivered","returnedBack","canceled","returningBack","onResend","refundInProcess","receivedBack","partlyReceivedBack","preReceived","incorrect","suspended","waitingForPayment","productsNotAvailable","packed","waitingForCarrier"]},"timestamp":{"description":"Timestamp when the order was created","type":"string","format":"date"},"updatedAt":{"description":"Timestamp when the order was updated","type":"string","format":"date"},"deliveredAt":{"type":"string","format":"date"},"canceledAt":{"type":"string","format":"date"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","format":"date"},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"shipperServiceCode":{"type":"string","description":"Value from endpoint (GET) /v2/shipper-service-codes"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"disableShippingReorder":{"type":"boolean","description":"If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace."},"marketplace":{"type":"string","description":"Order marketplace origin. Required if disableShippingReorder is set to true.","enum":["alza","allegro","kaufland","mall","other"]},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"waitingForPaymentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for payment"},"productsNotAvailableAt":{"type":["string","null"],"format":"date-time","description":"Date and time when products are not available"},"suspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was suspended"},"releaseFromSuspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was released from suspension"},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing"},"incorrectAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was marked as incorrect"},"waitingForShipmentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for shipment creation"},"shipmentOrderedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"inProcessAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is in process"},"packedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was packed"},"waitingForCarrierAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for the carrier"},"shippedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"returningBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is returning back"},"returnedBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order entered returned back status"},"parentOrderId":{"type":["integer","null"],"description":"ID of the parent order"},"parentEshopOrderId":{"type":["string","null"],"description":"ID of the parent order in the e-shop"},"returnTrackingNumber":{"type":["string","null"],"description":"Return tracking number"},"exchangeTrackingNumber":{"type":["string","null"],"description":"Exchange tracking number"},"eshopNote":{"type":["string","null"],"description":"E-shop note"},"orderBoxCount":{"type":["integer","null"],"description":"Number of boxes in the order"},"incorrectOrderMessage":{"type":["string","null"],"description":"Incorrect order message"}},"required":["eshopOrderId","orderType"]},"trackingNumbers":{"type":"array","items":{"type":"string"}},"GridRequest":{"type":"object","properties":{"page":{"type":"integer","description":"Page number, can be used for pagination","default":1,"minimum":1},"items":{"type":"integer","description":"items per page","default":10,"minimum":1,"maximum":1000},"columns":{"$ref":"#/components/schemas/Columns"},"sorts":{"$ref":"#/components/schemas/Sorts"},"filters":{"$ref":"#/components/schemas/Model32"}}},"Columns":{"type":"array","description":"List of columns you want to retrieve. If empty, all possible columns will be retrieved","items":{"$ref":"#/components/schemas/OrderFieldsEnum"}},"OrderFieldsEnum":{"type":"string","enum":["id","addressId","allowExpedition","billingAddressAdditionalInfo","billingAddressAdditionalInfo2","billingAttentionName","billingCity","billingCompanyId","billingCompanyName","billingEmail","billingName","billingPhone","billingPostCode","billingProvinceCode","billingState","billingStreet","billingTaxId","codCurrency","codPrice","codRefNumber","currency","eshopOrderId","invoiceDate","invoiceNumber","marketplace","message","method","note","orderType","paid","partnerOrderId","paymentMethod","price","printFiles","holdByQuality","underSanction","priority","recipientAddressAdditionalInfo","recipientAddressAdditionalInfo2","recipientAttentionName","recipientCity","recipientCompanyId","recipientCompanyName","recipientEmail","recipientName","recipientPhone","recipientPostCode","recipientProvinceCode","recipientState","recipientStreet","recipientTaxId","shipper","shipperServiceCode","shippingPrice","branchId","status","timestamp","requiredExpeditionDate","trackingNumbers","recipientGln","billingGln","deliveredAt","canceledAt","disableShippingReorder","underSanction","updatedAt","waitingForPaymentAt","productsNotAvailableAt","suspendedAt","releaseFromSuspendedAt","incorrectAt","waitingForShipmentAt","shipmentOrderedAt","inProcessAt","packedAt","waitingForCarrierAt","shippedAt","returningBackAt","returnedBackAt","parentOrderId","parentEshopOrderId","returnTrackingNumber","exchangeTrackingNumber","eshopNote","orderBoxCount","incorrectOrderMessage"]},"Sorts":{"type":"array","description":"Array of sorts","items":{"$ref":"#/components/schemas/SortItem"}},"SortItem":{"type":"object","properties":{"column":{"$ref":"#/components/schemas/OrderFieldsEnum","description":"Name of the column to order by"},"direction":{"type":"string","description":"Direction of the order","enum":["ASC","DESC","asc","desc"]}},"required":["column","direction"]},"Model32":{"type":"array","description":"Array of AndFilters. They will be joined with OR operator.","items":{"$ref":"#/components/schemas/Model31"}},"Model31":{"type":"array","description":"Array of AND filters. Filters you specify in this array will be joined with AND operator.","items":{"$ref":"#/components/schemas/FilterItem"}},"FilterItem":{"type":"object","properties":{"column":{"$ref":"#/components/schemas/OrderFieldsEnum","description":"Name of the column to filter by","minLength":2},"operator":{"type":"string","description":"\n                                eq - equal\n                                neq - not equal\n                                gt -  greater than\n                                gte - greater than or equal\n                                lt - less than\n                                lte - less than equal\n                                in - in array of values (expects array of values in value property)\n                                nin - not in array of values (expects array of values in value property)\n                                like - like\n                                nline - not like\n                                between - between given interval (expects array of two values in value),\n                                nbetween - not between given interval (expects array of two values in value)\n                                null - is null\n                                notnull - is not null\n                                empty - is null or empty string\n                                notempty - is not null neither empty string","enum":["eq","neq","like","nlike","gt","lt","gte","lte","in","nin","between","nbetween","null","notnull","empty","notempty"]},"value":{"type":"string","description":"Value can be string, number, boolean, array or null"}},"required":["column","operator","value"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/orders/filter":{"post":{"summary":"Filter orders","operationId":"postOrdersFilter","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true}],"tags":["Orders"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersGridResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GridRequest"}}}}}}}}
```

## GET /orders/{eshopOrderId}

> Get order detail

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"OrderResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/OrderWithFiles"}},"required":["statusCode","message"]},"OrderWithFiles":{"allOf":[{"$ref":"#/components/schemas/OrderWithoutProduct"},{"type":"object","properties":{"orderProducts":{"$ref":"#/components/schemas/OrderProducts"},"orderFiles":{"$ref":"#/components/schemas/FilesResponse"}}}]},"OrderWithoutProduct":{"type":"object","properties":{"id":{"type":"number"},"status":{"type":"string","enum":["inProcess","lost","received","processing","processed","onTheWay","delivered","returnedBack","canceled","returningBack","onResend","refundInProcess","receivedBack","partlyReceivedBack","preReceived","incorrect","suspended","waitingForPayment","productsNotAvailable","packed","waitingForCarrier"]},"timestamp":{"description":"Timestamp when the order was created","type":"string","format":"date"},"updatedAt":{"description":"Timestamp when the order was updated","type":"string","format":"date"},"deliveredAt":{"type":"string","format":"date"},"canceledAt":{"type":"string","format":"date"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","format":"date"},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"shipperServiceCode":{"type":"string","description":"Value from endpoint (GET) /v2/shipper-service-codes"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"disableShippingReorder":{"type":"boolean","description":"If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace."},"marketplace":{"type":"string","description":"Order marketplace origin. Required if disableShippingReorder is set to true.","enum":["alza","allegro","kaufland","mall","other"]},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"waitingForPaymentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for payment"},"productsNotAvailableAt":{"type":["string","null"],"format":"date-time","description":"Date and time when products are not available"},"suspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was suspended"},"releaseFromSuspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was released from suspension"},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing"},"incorrectAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was marked as incorrect"},"waitingForShipmentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for shipment creation"},"shipmentOrderedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"inProcessAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is in process"},"packedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was packed"},"waitingForCarrierAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for the carrier"},"shippedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"returningBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is returning back"},"returnedBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order entered returned back status"},"parentOrderId":{"type":["integer","null"],"description":"ID of the parent order"},"parentEshopOrderId":{"type":["string","null"],"description":"ID of the parent order in the e-shop"},"returnTrackingNumber":{"type":["string","null"],"description":"Return tracking number"},"exchangeTrackingNumber":{"type":["string","null"],"description":"Exchange tracking number"},"eshopNote":{"type":["string","null"],"description":"E-shop note"},"orderBoxCount":{"type":["integer","null"],"description":"Number of boxes in the order"},"incorrectOrderMessage":{"type":["string","null"],"description":"Incorrect order message"}},"required":["eshopOrderId","orderType"]},"trackingNumbers":{"type":"array","items":{"type":"string"}},"OrderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","items":{"$ref":"#/components/schemas/OrderProduct"}},"OrderProduct":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"lot":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"packingLists":{"$ref":"#/components/schemas/packingLists"},"customizationText":{"type":"string","description":"Text for product customization"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"confirmed":{"type":"string","description":"Confirmed product count"},"missingCount":{"type":"number","description":"Missing product count"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order. Must be unique for every order if set."},"orderProductFiles":{"$ref":"#/components/schemas/Files"}},"required":["sku","productPrice","count"]},"CustomizationType":{"type":"string","description":"Product customization type","enum":["engraving","stamping","grinding"]},"packingLists":{"type":"array","description":"Packing Lists for order product SKU. Only returned if withPackingLists param is used in GET endpoint","items":{"$ref":"#/components/schemas/Model7"}},"Model7":{"type":"object","properties":{"id":{"type":"number"},"expeditionPalletNumber":{"type":"string"},"expeditionBoxNumber":{"type":"string"},"ssccCode":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/serialNumbers"},"lots":{"type":"array","items":{"type":"string"}},"expDates":{"type":"array","items":{"type":"string"}},"count":{"type":"number"}}},"serialNumbers":{"type":"array","items":{"type":"string"}},"bcxCodes":{"type":"array","items":{"type":"string"}},"Files":{"type":"array","description":"Order product files","items":{"$ref":"#/components/schemas/File"}},"File":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"FilesResponse":{"type":"array","description":"Order files response","items":{"$ref":"#/components/schemas/FileNoData"}},"FileNoData":{"type":"object","properties":{"type":{"type":"string","enum":["invoice","shippingAddonLabel","shipResponse","other"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/orders/{eshopOrderId}":{"get":{"summary":"Get order detail","operationId":"getOrdersEshoporderid","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"string"},"name":"eshopOrderId","in":"path","required":true},{"schema":{"type":"boolean"},"name":"withPackingLists","in":"query","description":"If turned on it returns information what SKUs are in which packing together with SSCC codes, serial numbers etc.","required":false}],"tags":["Orders"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}}}}}}
```

## POST /orders

> Create new order

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"OrderResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/OrderWithFiles"}},"required":["statusCode","message"]},"OrderWithFiles":{"allOf":[{"$ref":"#/components/schemas/OrderWithoutProduct"},{"type":"object","properties":{"orderProducts":{"$ref":"#/components/schemas/OrderProducts"},"orderFiles":{"$ref":"#/components/schemas/FilesResponse"}}}]},"OrderWithoutProduct":{"type":"object","properties":{"id":{"type":"number"},"status":{"type":"string","enum":["inProcess","lost","received","processing","processed","onTheWay","delivered","returnedBack","canceled","returningBack","onResend","refundInProcess","receivedBack","partlyReceivedBack","preReceived","incorrect","suspended","waitingForPayment","productsNotAvailable","packed","waitingForCarrier"]},"timestamp":{"description":"Timestamp when the order was created","type":"string","format":"date"},"updatedAt":{"description":"Timestamp when the order was updated","type":"string","format":"date"},"deliveredAt":{"type":"string","format":"date"},"canceledAt":{"type":"string","format":"date"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","format":"date"},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"shipperServiceCode":{"type":"string","description":"Value from endpoint (GET) /v2/shipper-service-codes"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"disableShippingReorder":{"type":"boolean","description":"If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace."},"marketplace":{"type":"string","description":"Order marketplace origin. Required if disableShippingReorder is set to true.","enum":["alza","allegro","kaufland","mall","other"]},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"waitingForPaymentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for payment"},"productsNotAvailableAt":{"type":["string","null"],"format":"date-time","description":"Date and time when products are not available"},"suspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was suspended"},"releaseFromSuspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was released from suspension"},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing"},"incorrectAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was marked as incorrect"},"waitingForShipmentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for shipment creation"},"shipmentOrderedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"inProcessAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is in process"},"packedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was packed"},"waitingForCarrierAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for the carrier"},"shippedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"returningBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is returning back"},"returnedBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order entered returned back status"},"parentOrderId":{"type":["integer","null"],"description":"ID of the parent order"},"parentEshopOrderId":{"type":["string","null"],"description":"ID of the parent order in the e-shop"},"returnTrackingNumber":{"type":["string","null"],"description":"Return tracking number"},"exchangeTrackingNumber":{"type":["string","null"],"description":"Exchange tracking number"},"eshopNote":{"type":["string","null"],"description":"E-shop note"},"orderBoxCount":{"type":["integer","null"],"description":"Number of boxes in the order"},"incorrectOrderMessage":{"type":["string","null"],"description":"Incorrect order message"}},"required":["eshopOrderId","orderType"]},"trackingNumbers":{"type":"array","items":{"type":"string"}},"OrderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","items":{"$ref":"#/components/schemas/OrderProduct"}},"OrderProduct":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"lot":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"packingLists":{"$ref":"#/components/schemas/packingLists"},"customizationText":{"type":"string","description":"Text for product customization"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"confirmed":{"type":"string","description":"Confirmed product count"},"missingCount":{"type":"number","description":"Missing product count"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order. Must be unique for every order if set."},"orderProductFiles":{"$ref":"#/components/schemas/Files"}},"required":["sku","productPrice","count"]},"CustomizationType":{"type":"string","description":"Product customization type","enum":["engraving","stamping","grinding"]},"packingLists":{"type":"array","description":"Packing Lists for order product SKU. Only returned if withPackingLists param is used in GET endpoint","items":{"$ref":"#/components/schemas/Model7"}},"Model7":{"type":"object","properties":{"id":{"type":"number"},"expeditionPalletNumber":{"type":"string"},"expeditionBoxNumber":{"type":"string"},"ssccCode":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/serialNumbers"},"lots":{"type":"array","items":{"type":"string"}},"expDates":{"type":"array","items":{"type":"string"}},"count":{"type":"number"}}},"serialNumbers":{"type":"array","items":{"type":"string"}},"bcxCodes":{"type":"array","items":{"type":"string"}},"Files":{"type":"array","description":"Order product files","items":{"$ref":"#/components/schemas/File"}},"File":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"FilesResponse":{"type":"array","description":"Order files response","items":{"$ref":"#/components/schemas/FileNoData"}},"FileNoData":{"type":"object","properties":{"type":{"type":"string","enum":["invoice","shippingAddonLabel","shipResponse","other"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ErrorResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"OrderWithProducts":{"type":"object","properties":{"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"status":{"type":"string","description":"Optional initial status. Allowed values are preReceived (default) or preOrder. preReceived is the normal default status, preOrder is for pre-orders that should not be picked yet.","enum":["preReceived","preOrder"]},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing. Use for pre-orders (status preOrder) to schedule automatic release."},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":["string","null"],"description":"Required expedition date for B2B orders"},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string","description":"Use the 'shipper' field obtained from GET /v2/shipper-service-codes endpoint"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"shipperServiceCode":{"type":"string","description":"Use the 'value' field obtained from GET /v2/shipper-service-codes endpoint"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"trackingNumbers":{"type":"array","description":"Tracking numbers","items":{"type":"string"}},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"disableShippingReorder":{"type":"boolean","description":"If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace."},"marketplace":{"type":"string","description":"Order marketplace origin. Required if disableShippingReorder is set to true.","enum":["alza","allegro","kaufland","mall","other"]},"orderProducts":{"$ref":"#/components/schemas/orderProducts"},"orderFiles":{"$ref":"#/components/schemas/OrderFilesCreate"}},"required":["eshopOrderId","orderType","orderProducts"]},"orderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","minItems":1,"items":{"$ref":"#/components/schemas/OrderProductPayload"}},"OrderProductPayload":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"locationId":{"type":"string"},"lot":{"type":"string"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"customizationText":{"type":"string","description":"Text for product customization"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"orderProductFiles":{"$ref":"#/components/schemas/OrderProductFilesPayload"}},"required":["sku","productPrice","count"]},"OrderProductFilesPayload":{"type":"array","description":"You must send all files you received in GET order endpoint. Files you dont send will be deleted. Must be unique for every order if set.","items":{"$ref":"#/components/schemas/OrderProductFilePayload"}},"OrderProductFilePayload":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"data":{"type":"string","description":"base64 encoded data of file. required for new files, not required with update for existing files","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"OrderFilesCreate":{"type":"array","items":{"$ref":"#/components/schemas/OrderFileCreate"}},"OrderFileCreate":{"type":"object","properties":{"type":{"type":"string","description":"invoice (will be included in the package), shippingAddonLabel (will printed on the package)","enum":["invoice","shippingAddonLabel"],"minLength":1},"data":{"type":"string","description":"base64 encoded data of file","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"}},"required":["type","data","fileName","fileType"]}}},"paths":{"/orders":{"post":{"summary":"Create new order","operationId":"postOrders","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true}],"tags":["Orders"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"409":{"description":"Conflict response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWithProducts"}}}}}}}}
```

## PUT /orders/{eshopOrderId}

> Updates order

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"OrderResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/OrderWithFiles"}},"required":["statusCode","message"]},"OrderWithFiles":{"allOf":[{"$ref":"#/components/schemas/OrderWithoutProduct"},{"type":"object","properties":{"orderProducts":{"$ref":"#/components/schemas/OrderProducts"},"orderFiles":{"$ref":"#/components/schemas/FilesResponse"}}}]},"OrderWithoutProduct":{"type":"object","properties":{"id":{"type":"number"},"status":{"type":"string","enum":["inProcess","lost","received","processing","processed","onTheWay","delivered","returnedBack","canceled","returningBack","onResend","refundInProcess","receivedBack","partlyReceivedBack","preReceived","incorrect","suspended","waitingForPayment","productsNotAvailable","packed","waitingForCarrier"]},"timestamp":{"description":"Timestamp when the order was created","type":"string","format":"date"},"updatedAt":{"description":"Timestamp when the order was updated","type":"string","format":"date"},"deliveredAt":{"type":"string","format":"date"},"canceledAt":{"type":"string","format":"date"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","format":"date"},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"shipperServiceCode":{"type":"string","description":"Value from endpoint (GET) /v2/shipper-service-codes"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"disableShippingReorder":{"type":"boolean","description":"If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace."},"marketplace":{"type":"string","description":"Order marketplace origin. Required if disableShippingReorder is set to true.","enum":["alza","allegro","kaufland","mall","other"]},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"waitingForPaymentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for payment"},"productsNotAvailableAt":{"type":["string","null"],"format":"date-time","description":"Date and time when products are not available"},"suspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was suspended"},"releaseFromSuspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was released from suspension"},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing"},"incorrectAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was marked as incorrect"},"waitingForShipmentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for shipment creation"},"shipmentOrderedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"inProcessAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is in process"},"packedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was packed"},"waitingForCarrierAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for the carrier"},"shippedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"returningBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is returning back"},"returnedBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order entered returned back status"},"parentOrderId":{"type":["integer","null"],"description":"ID of the parent order"},"parentEshopOrderId":{"type":["string","null"],"description":"ID of the parent order in the e-shop"},"returnTrackingNumber":{"type":["string","null"],"description":"Return tracking number"},"exchangeTrackingNumber":{"type":["string","null"],"description":"Exchange tracking number"},"eshopNote":{"type":["string","null"],"description":"E-shop note"},"orderBoxCount":{"type":["integer","null"],"description":"Number of boxes in the order"},"incorrectOrderMessage":{"type":["string","null"],"description":"Incorrect order message"}},"required":["eshopOrderId","orderType"]},"trackingNumbers":{"type":"array","items":{"type":"string"}},"OrderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","items":{"$ref":"#/components/schemas/OrderProduct"}},"OrderProduct":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"lot":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"packingLists":{"$ref":"#/components/schemas/packingLists"},"customizationText":{"type":"string","description":"Text for product customization"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"confirmed":{"type":"string","description":"Confirmed product count"},"missingCount":{"type":"number","description":"Missing product count"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order. Must be unique for every order if set."},"orderProductFiles":{"$ref":"#/components/schemas/Files"}},"required":["sku","productPrice","count"]},"CustomizationType":{"type":"string","description":"Product customization type","enum":["engraving","stamping","grinding"]},"packingLists":{"type":"array","description":"Packing Lists for order product SKU. Only returned if withPackingLists param is used in GET endpoint","items":{"$ref":"#/components/schemas/Model7"}},"Model7":{"type":"object","properties":{"id":{"type":"number"},"expeditionPalletNumber":{"type":"string"},"expeditionBoxNumber":{"type":"string"},"ssccCode":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/serialNumbers"},"lots":{"type":"array","items":{"type":"string"}},"expDates":{"type":"array","items":{"type":"string"}},"count":{"type":"number"}}},"serialNumbers":{"type":"array","items":{"type":"string"}},"bcxCodes":{"type":"array","items":{"type":"string"}},"Files":{"type":"array","description":"Order product files","items":{"$ref":"#/components/schemas/File"}},"File":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"FilesResponse":{"type":"array","description":"Order files response","items":{"$ref":"#/components/schemas/FileNoData"}},"FileNoData":{"type":"object","properties":{"type":{"type":"string","enum":["invoice","shippingAddonLabel","shipResponse","other"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"OrderUpdateRequest":{"type":"object","properties":{"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","description":"Required expedition date for B2B orders."},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string","description":"Use the 'shipper' field obtained from GET /v2/shipper-service-codes endpoint"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"shipperServiceCode":{"type":"string","description":"Use the 'value' field obtained from GET /v2/shipper-service-codes endpoint"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing. Use for pre-orders (status preOrder) to schedule automatic release."},"orderProducts":{"$ref":"#/components/schemas/orderProducts"},"orderFiles":{"$ref":"#/components/schemas/OrderFilesUpdates"},"status":{"type":"string","enum":["preOrder","canceled","suspended"]}},"required":["eshopOrderId","orderType","orderProducts"]},"orderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","minItems":1,"items":{"$ref":"#/components/schemas/OrderProductPayload"}},"OrderProductPayload":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"locationId":{"type":"string"},"lot":{"type":"string"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"customizationText":{"type":"string","description":"Text for product customization"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"orderProductFiles":{"$ref":"#/components/schemas/OrderProductFilesPayload"}},"required":["sku","productPrice","count"]},"OrderProductFilesPayload":{"type":"array","description":"You must send all files you received in GET order endpoint. Files you dont send will be deleted. Must be unique for every order if set.","items":{"$ref":"#/components/schemas/OrderProductFilePayload"}},"OrderProductFilePayload":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"data":{"type":"string","description":"base64 encoded data of file. required for new files, not required with update for existing files","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"OrderFilesUpdates":{"type":"array","description":"You must send all files you received in GET order endpoint. Files you dont send will be deleted.","items":{"$ref":"#/components/schemas/OrderFileUpdate"}},"OrderFileUpdate":{"type":"object","properties":{"type":{"type":"string","description":"invoice (will be included in the package), shippingAddonLabel (will printed on the package)","enum":["invoice","shippingAddonLabel","shipResponse","other"],"minLength":1},"data":{"type":"string","description":"base64 encoded data of file. required for new files, not required with update for existing files","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]}}},"paths":{"/orders/{eshopOrderId}":{"put":{"summary":"Updates order","operationId":"putOrdersEshoporderid","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"string"},"name":"eshopOrderId","in":"path","required":true}],"tags":["Orders"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUpdateRequest"}}}}}}}}
```

## PATCH /orders/{eshopOrderId}

> Partially update order

```json
{"openapi":"3.1.1","info":{"title":"Public Gateway Documentation","version":"2.0.0"},"servers":[{"url":"https://gw.new.skladon.net/v2"}],"security":[{"authorization":[],"XApiKey":[]}],"components":{"securitySchemes":{"authorization":{"type":"apiKey","name":"authorization","in":"header"}},"schemas":{"OrderResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/OrderWithFiles"}},"required":["statusCode","message"]},"OrderWithFiles":{"allOf":[{"$ref":"#/components/schemas/OrderWithoutProduct"},{"type":"object","properties":{"orderProducts":{"$ref":"#/components/schemas/OrderProducts"},"orderFiles":{"$ref":"#/components/schemas/FilesResponse"}}}]},"OrderWithoutProduct":{"type":"object","properties":{"id":{"type":"number"},"status":{"type":"string","enum":["inProcess","lost","received","processing","processed","onTheWay","delivered","returnedBack","canceled","returningBack","onResend","refundInProcess","receivedBack","partlyReceivedBack","preReceived","incorrect","suspended","waitingForPayment","productsNotAvailable","packed","waitingForCarrier"]},"timestamp":{"description":"Timestamp when the order was created","type":"string","format":"date"},"updatedAt":{"description":"Timestamp when the order was updated","type":"string","format":"date"},"deliveredAt":{"type":"string","format":"date"},"canceledAt":{"type":"string","format":"date"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","format":"date"},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"shipperServiceCode":{"type":"string","description":"Value from endpoint (GET) /v2/shipper-service-codes"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"disableShippingReorder":{"type":"boolean","description":"If set to true, standard shipping wont be ordered. It is necessary to pass shippingAddonLabel to order files and set value for marketplace."},"marketplace":{"type":"string","description":"Order marketplace origin. Required if disableShippingReorder is set to true.","enum":["alza","allegro","kaufland","mall","other"]},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"waitingForPaymentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for payment"},"productsNotAvailableAt":{"type":["string","null"],"format":"date-time","description":"Date and time when products are not available"},"suspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was suspended"},"releaseFromSuspendedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was released from suspension"},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing"},"incorrectAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was marked as incorrect"},"waitingForShipmentAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for shipment creation"},"shipmentOrderedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"inProcessAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is in process"},"packedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was packed"},"waitingForCarrierAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is waiting for the carrier"},"shippedAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order was shipped"},"returningBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order is returning back"},"returnedBackAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order entered returned back status"},"parentOrderId":{"type":["integer","null"],"description":"ID of the parent order"},"parentEshopOrderId":{"type":["string","null"],"description":"ID of the parent order in the e-shop"},"returnTrackingNumber":{"type":["string","null"],"description":"Return tracking number"},"exchangeTrackingNumber":{"type":["string","null"],"description":"Exchange tracking number"},"eshopNote":{"type":["string","null"],"description":"E-shop note"},"orderBoxCount":{"type":["integer","null"],"description":"Number of boxes in the order"},"incorrectOrderMessage":{"type":["string","null"],"description":"Incorrect order message"}},"required":["eshopOrderId","orderType"]},"trackingNumbers":{"type":"array","items":{"type":"string"}},"OrderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","items":{"$ref":"#/components/schemas/OrderProduct"}},"OrderProduct":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"lot":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"packingLists":{"$ref":"#/components/schemas/packingLists"},"customizationText":{"type":"string","description":"Text for product customization"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"confirmed":{"type":"string","description":"Confirmed product count"},"missingCount":{"type":"number","description":"Missing product count"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order. Must be unique for every order if set."},"orderProductFiles":{"$ref":"#/components/schemas/Files"}},"required":["sku","productPrice","count"]},"CustomizationType":{"type":"string","description":"Product customization type","enum":["engraving","stamping","grinding"]},"packingLists":{"type":"array","description":"Packing Lists for order product SKU. Only returned if withPackingLists param is used in GET endpoint","items":{"$ref":"#/components/schemas/Model7"}},"Model7":{"type":"object","properties":{"id":{"type":"number"},"expeditionPalletNumber":{"type":"string"},"expeditionBoxNumber":{"type":"string"},"ssccCode":{"type":"string"},"serialNumbers":{"$ref":"#/components/schemas/serialNumbers"},"lots":{"type":"array","items":{"type":"string"}},"expDates":{"type":"array","items":{"type":"string"}},"count":{"type":"number"}}},"serialNumbers":{"type":"array","items":{"type":"string"}},"bcxCodes":{"type":"array","items":{"type":"string"}},"Files":{"type":"array","description":"Order product files","items":{"$ref":"#/components/schemas/File"}},"File":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"FilesResponse":{"type":"array","description":"Order files response","items":{"$ref":"#/components/schemas/FileNoData"}},"FileNoData":{"type":"object","properties":{"type":{"type":"string","enum":["invoice","shippingAddonLabel","shipResponse","other"],"minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"OrderUpdateRequest":{"type":"object","properties":{"eshopOrderId":{"type":"string","description":"Unique order ID from the e-shop. Used to check whether the order has not already been created in MySkladon. The ideal value is the unique order identifier from the e-shop."},"invoiceNumber":{"type":"string"},"orderType":{"type":"string","enum":["b2c","b2b","transfer"]},"invoiceDate":{"type":"string"},"requiredExpeditionDate":{"type":"string","description":"Required expedition date for B2B orders."},"partnerOrderId":{"type":"string"},"recipientName":{"type":"string"},"recipientAttentionName":{"type":"string"},"recipientEmail":{"type":"string"},"recipientPhone":{"type":"string"},"recipientCompanyName":{"type":"string"},"recipientCompanyId":{"description":"Must be filled for transfer order type. Value can be found in MYS at Settings -> Provider transfer companies","type":"string"},"recipientTaxId":{"type":"string"},"recipientStreet":{"type":"string"},"recipientAddressAdditionalInfo":{"type":"string"},"recipientCity":{"type":"string"},"recipientState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"recipientProvinceCode":{"type":"string"},"recipientPostCode":{"type":"string"},"recipientGln":{"type":"string"},"billingName":{"type":"string"},"billingAttentionName":{"type":"string"},"billingEmail":{"type":"string"},"billingPhone":{"type":"string"},"billingCompanyName":{"type":"string"},"billingCompanyId":{"type":"string"},"billingTaxId":{"type":"string"},"billingStreet":{"type":"string"},"billingAddressAdditionalInfo":{"type":"string"},"billingCity":{"type":"string"},"billingState":{"type":"string","description":"ISO 3166-1 Alpha-2 code (2 characters). https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","minLength":2,"maxLength":2},"billingProvinceCode":{"type":"string"},"billingPostCode":{"type":"string"},"billingGln":{"type":"string"},"shipper":{"type":"string","description":"Use the 'shipper' field obtained from GET /v2/shipper-service-codes endpoint"},"addressId":{"type":"string","description":"ID of carrier's pickup point"},"message":{"type":"string"},"paid":{"type":"boolean","description":"True if order is paid, false otherwise."},"paymentMethod":{"type":"string","description":"0 - cash on delivery, 1 - card online, 2 - bank transfer","enum":["0","1","2"]},"price":{"type":"number"},"currency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"shippingPrice":{"type":"number"},"codPrice":{"type":"number","minimum":0},"codCurrency":{"type":"string","description":"https://en.wikipedia.org/wiki/ISO_4217"},"codRefNumber":{"type":"string","minLength":1},"note":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"shipperServiceCode":{"type":"string","description":"Use the 'value' field obtained from GET /v2/shipper-service-codes endpoint"},"branchId":{"type":["string","null"],"description":"Identifier of the e-shop branch where orders are sent together. Optional field."},"allowExpedition":{"type":"boolean","default":true},"printReturnLabel":{"type":"boolean"},"printFiles":{"type":"boolean","description":"If true order file with \"invoice\" type will be printed "},"holdByQuality":{"type":"boolean","description":"If true order will be picked from quality"},"trackingNumbers":{"$ref":"#/components/schemas/trackingNumbers"},"underSanction":{"type":"boolean","description":"If set to true, order is marked as under sanction. Only for B2B orders."},"priority":{"type":"number","description":"Order priority. 0 - normal, 1 - high","default":0,"enum":[0,1]},"preorderReleaseAt":{"type":["string","null"],"format":"date-time","description":"Date and time when the order will be released from preOrder status for processing. Use for pre-orders (status preOrder) to schedule automatic release."},"orderProducts":{"$ref":"#/components/schemas/orderProducts"},"orderFiles":{"$ref":"#/components/schemas/OrderFilesUpdates"},"status":{"type":"string","enum":["preOrder","canceled","suspended"]}},"required":["eshopOrderId","orderType","orderProducts"]},"orderProducts":{"type":"array","description":"If you dont send existing order product in update it will be marked with disabled (lineState D)","minItems":1,"items":{"$ref":"#/components/schemas/OrderProductPayload"}},"OrderProductPayload":{"type":"object","properties":{"sku":{"type":"string","minLength":1},"productPrice":{"type":"number","minimum":0},"count":{"type":"number","minimum":1},"locationId":{"type":"string"},"lot":{"type":"string"},"customsProductType":{"type":"string","default":"saleOfGoods","enum":["gift","documents","saleOfGoods","commercialSample","returnedGoods"]},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]},"customizationType":{"$ref":"#/components/schemas/CustomizationType"},"customizationText":{"type":"string","description":"Text for product customization"},"eshopOrderProductId":{"type":"string","description":"Optional unique client id of product in order"},"bcxCodes":{"$ref":"#/components/schemas/bcxCodes","description":"BCX codes to be printed on order product."},"orderProductFiles":{"$ref":"#/components/schemas/OrderProductFilesPayload"}},"required":["sku","productPrice","count"]},"OrderProductFilesPayload":{"type":"array","description":"You must send all files you received in GET order endpoint. Files you dont send will be deleted. Must be unique for every order if set.","items":{"$ref":"#/components/schemas/OrderProductFilePayload"}},"OrderProductFilePayload":{"type":"object","properties":{"type":{"type":"string","enum":["other","engravingType"],"minLength":1},"data":{"type":"string","description":"base64 encoded data of file. required for new files, not required with update for existing files","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]},"OrderFilesUpdates":{"type":"array","description":"You must send all files you received in GET order endpoint. Files you dont send will be deleted.","items":{"$ref":"#/components/schemas/OrderFileUpdate"}},"OrderFileUpdate":{"type":"object","properties":{"type":{"type":"string","description":"invoice (will be included in the package), shippingAddonLabel (will printed on the package)","enum":["invoice","shippingAddonLabel","shipResponse","other"],"minLength":1},"data":{"type":"string","description":"base64 encoded data of file. required for new files, not required with update for existing files","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","enum":["PDF","ZPL"],"minLength":1},"fileSize":{"type":"string"},"id":{"type":"number","description":"not required for new files, required with update for existing files","minimum":1}},"required":["type","fileName","fileType"]}}},"paths":{"/orders/{eshopOrderId}":{"patch":{"summary":"Partially update order","operationId":"patchOrdersEshoporderid","parameters":[{"schema":{"type":"string"},"description":"This is the eshop key you receive during onboarding.","name":"x-api-key","in":"header","required":true},{"schema":{"type":"string"},"description":"Token you get from calling /users/login","name":"authorization","in":"header","required":true},{"schema":{"type":"string"},"name":"eshopOrderId","in":"path","required":true}],"tags":["Orders"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}},"404":{"description":"Not found response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUpdateRequest"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://dev.skladon.com/main/v2/integration/api/orders.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.