> 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/receivings.md). # Receivings You may find descriptions of endpoints for work with receivings bellow. ## POST /receivings/filter > Filter receivings ```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":{"ReceivingsGridResponse":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/ReceivingsGrid"}},"required":["statusCode","message"]},"ReceivingsGrid":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Receivings"},"request":{"$ref":"#/components/schemas/ReceivingGridRequest"},"totalCount":{"type":"number"}}},"Receivings":{"type":"array","items":{"$ref":"#/components/schemas/Receiving"}},"Receiving":{"type":"object","properties":{"eshopReceivingId":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"trackingNumber":{"type":"string","minLength":1},"supplier":{"type":"string","minLength":1},"estimatedDelivery":{"type":"string","format":"date"},"deliveryNoteNumber":{"type":"string","minLength":1},"deliveryType":{"type":"string","enum":["courier","transportCompany","truckingCompany","container"]},"urgent":{"type":"string","enum":["ok","afterUrgent","recievedWithoutAsn"]},"duty":{"type":"boolean"},"unitsAmount":{"type":"number","minimum":1},"driverCompany":{"type":"string"},"driverTrailerLicensePlate":{"type":"string"},"driverName":{"type":"string"},"driverPhone":{"type":"string"},"driverDispatcherContact":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"priority":{"type":"number","description":"Priority level (0=Normal, 1=High)","enum":[0,1],"default":0},"containerNumber":{"type":"string","description":"Container number for container transport"},"announcedPalletsCount":{"type":"number","description":"Number of announced pallets","minimum":0},"receivingType":{"type":"string","description":"Type of receiving","enum":["piece_mix","carton_single","carton_mix","pallet_single","pallet_mix"]},"incoterms":{"type":"string","description":"Delivery terms (Incoterms)","enum":["FOB","CPT","CIP","DPU","DAP","DDP"]},"realDelivery":{"type":"string","format":"date-time","description":"Real delivery date from DCIx (read-only)"},"slaSuspended":{"type":"string","description":"SLA suspended status from DCIx (read-only)"},"photoDocumentationTaken":{"type":"string","description":"Photo documentation status from DCIx (read-only)"},"deliveredPalletsCount":{"type":"number","description":"Number of delivered EUR pallets from DCIx (read-only)"},"deliveredCartonsCount":{"type":"number","description":"Number of delivered cartons from DCIx (read-only)"},"returnedEurPalletsCount":{"type":"number","description":"Number of returned EUR pallets from DCIx (read-only)"},"deliveredStandardPalletsCount":{"type":"number","description":"Number of delivered STANDARD pallets from DCIx (read-only)"},"returnedStandardPalletsCount":{"type":"number","description":"Number of returned STANDARD pallets from DCIx (read-only)"},"deliveredOtherPalletsCount":{"type":"number","description":"Number of delivered OTHER pallets from DCIx (read-only)"},"deliveredBrokenPalletsCount":{"type":"number","description":"Number of delivered BROKEN pallets from DCIx (read-only)"},"skladonNote":{"type":"string","description":"Skladon note (read-only)"},"unloadedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was unloaded (read-only)"},"receivedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving started processing (status received, read-only)"},"confirmedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was confirmed (read-only)"},"canceledAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was canceled (read-only)"},"status":{"type":"string","enum":["awaiting","received","confirmed","canceled"]}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount"]},"ReceivingGridRequest":{"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/ReceivingColumns"},"sorts":{"$ref":"#/components/schemas/ReceivingSorts"},"filters":{"$ref":"#/components/schemas/Model36"}}},"ReceivingColumns":{"type":"array","description":"List of columns you want to retrieve. If empty, all possible columns will be retrieved","items":{"$ref":"#/components/schemas/ReceivingColumnEnum"}},"ReceivingColumnEnum":{"type":"string","enum":["eshopReceivingId","deliveryNoteNumber","deliveryType","description","driverCompany","driverDispatcherContact","driverName","driverPhone","driverTrailerLicensePlate","duty","estimatedDelivery","status","supplier","trackingNumber","unitsAmount","urgent","eshopNote","priority","containerNumber","announcedPalletsCount","receivingType","incoterms","realDelivery","slaSuspended","photoDocumentationTaken","deliveredPalletsCount","deliveredCartonsCount","returnedEurPalletsCount","deliveredStandardPalletsCount","returnedStandardPalletsCount","deliveredOtherPalletsCount","deliveredBrokenPalletsCount","skladonNote","unloadedAt","receivedAt","confirmedAt","canceledAt"]},"ReceivingSorts":{"type":"array","description":"Array of sorts","items":{"$ref":"#/components/schemas/ReceivingSortItem"}},"ReceivingSortItem":{"type":"object","properties":{"column":{"$ref":"#/components/schemas/ReceivingColumnEnum","description":"Name of the column to order by"},"direction":{"type":"string","description":"Direction of the order","enum":["ASC","DESC","asc","desc"]}},"required":["column","direction"]},"Model36":{"type":"array","description":"Array of AndFilters. They will be joined with OR operator.","items":{"$ref":"#/components/schemas/Model35"}},"Model35":{"type":"array","description":"Array of AND filters. Filters you specify in this array will be joined with AND operator.","items":{"$ref":"#/components/schemas/ReceivingFilterItem"}},"ReceivingFilterItem":{"type":"object","properties":{"column":{"$ref":"#/components/schemas/ReceivingColumnEnum","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 or array"}},"required":["column","operator","value"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/receivings/filter":{"post":{"summary":"Filter receivings","operationId":"postReceivingsFilter","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":["Receivings"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivingsGridResponse"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivingGridRequest"}}}}}}}} ``` ## GET /receivings/{eshopReceivingId} > Get receiving ```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":{"ReceivingResponseObject":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/ReceivingResponse"}},"required":["statusCode","message"]},"ReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceivingResponse"},{"type":"object","properties":{"asn":{"type":"string","description":"ASN number (read-only)"},"status":{"type":"string","enum":["awaiting","received","confirmed","canceled"]},"products":{"$ref":"#/components/schemas/ReceivingProductsResponse"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","products"]}]},"BaseReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"urgent":{"description":"Urgent status","type":"string","enum":["ok","afterUrgent","recievedWithoutAsn"]},"slaDate":{"type":"string","format":"date-time","description":"SLA date (read-only)"},"realDelivery":{"type":"string","format":"date-time","description":"Real delivery date from DCIx (read-only)"},"slaSuspended":{"type":"string","description":"SLA suspended status from DCIx (read-only)"},"photoDocumentationTaken":{"type":"string","description":"Photo documentation status from DCIx (read-only)"},"deliveredPalletsCount":{"type":"number","description":"Number of delivered EUR pallets from DCIx (read-only)"},"deliveredCartonsCount":{"type":"number","description":"Number of delivered cartons from DCIx (read-only)"},"returnedEurPalletsCount":{"type":"number","description":"Number of returned EUR pallets from DCIx (read-only)"},"deliveredStandardPalletsCount":{"type":"number","description":"Number of delivered STANDARD pallets from DCIx (read-only)"},"returnedStandardPalletsCount":{"type":"number","description":"Number of returned STANDARD pallets from DCIx (read-only)"},"deliveredOtherPalletsCount":{"type":"number","description":"Number of delivered OTHER pallets from DCIx (read-only)"},"deliveredBrokenPalletsCount":{"type":"number","description":"Number of delivered BROKEN pallets from DCIx (read-only)"},"skladonNote":{"type":"string","description":"Skladon note (read-only)"},"unloadedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was unloaded (read-only)"},"receivedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving started processing (status received, read-only)"},"confirmedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was confirmed (read-only)"}}}]},"BaseReceiving":{"type":"object","properties":{"eshopReceivingId":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"trackingNumber":{"type":"string","minLength":1},"supplier":{"type":"string","minLength":1},"estimatedDelivery":{"type":"string","format":"date"},"deliveryNoteNumber":{"type":"string","minLength":1},"deliveryType":{"type":"string","enum":["courier","transportCompany","truckingCompany","container"]},"duty":{"type":"boolean"},"unitsAmount":{"type":"number","minimum":1},"driverCompany":{"type":"string"},"asnLabelEmail":{"type":"string","description":"Email address for sending ASN label"},"driverTrailerLicensePlate":{"type":"string"},"driverName":{"type":"string"},"driverPhone":{"type":"string"},"driverDispatcherContact":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"priority":{"type":"number","description":"Priority level (0=Normal, 1=High)","enum":[0,1],"default":0},"containerNumber":{"type":"string","description":"Container number for container transport"},"announcedPalletsCount":{"type":"number","description":"Number of announced pallets","minimum":0},"receivingType":{"type":"string","description":"Type of receiving","enum":["piece_mix","carton_single","carton_mix","pallet_single","pallet_mix"]},"incoterms":{"type":"string","description":"Delivery terms (Incoterms)","enum":["FOB","CPT","CIP","DPU","DAP","DDP"]}}},"ReceivingProductsResponse":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductResponse"}},"ReceivingProductResponse":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"received":{"type":"number","description":"Quantity of products received physically","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"serialNumber":{"type":"string","description":"Serial number of received product"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]},"packagings":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Model11"}},"Model11":{"type":"object","properties":{"packagingType":{"type":"string","enum":["non_returnable_pallet","returnable_pallet_wood","returnable_pallet_not_wood"]},"pallet":{"type":"string","enum":["pallet_100x120_ippc","pallet_100x120_standard","pallet_80x120_eur_a","pallet_80x120_eur_b","pallet_80x120_standard","pallet_60x80_ippc","pallet_60x80_standard","unspecified"]},"quantity":{"type":"number","minimum":1}},"required":["packagingType","quantity"]},"ReceivingFiles":{"type":"array","items":{"$ref":"#/components/schemas/ReceivingFileItem"}},"ReceivingFileItem":{"type":"object","description":"Receiving attachment (Core receivings_files + files).","properties":{"id":{"type":"integer","minimum":1,"description":"Existing file id; omit for new uploads"},"data":{"type":"string","description":"Base64 file payload; required for new files"},"type":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","minLength":1},"fileSize":{"type":"string"},"description":{"type":"string","maxLength":500},"creatorRole":{"type":"string","enum":["skladon_employee","client"]}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/receivings/{eshopReceivingId}":{"get":{"summary":"Get receiving","operationId":"getReceivingsEshopreceivingid","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":"eshopReceivingId","in":"path","required":true}],"tags":["Receivings"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivingResponseObject"}}}},"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 /receivings > Create receiving ```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":{"ReceivingResponseObject":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/ReceivingResponse"}},"required":["statusCode","message"]},"ReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceivingResponse"},{"type":"object","properties":{"asn":{"type":"string","description":"ASN number (read-only)"},"status":{"type":"string","enum":["awaiting","received","confirmed","canceled"]},"products":{"$ref":"#/components/schemas/ReceivingProductsResponse"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","products"]}]},"BaseReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"urgent":{"description":"Urgent status","type":"string","enum":["ok","afterUrgent","recievedWithoutAsn"]},"slaDate":{"type":"string","format":"date-time","description":"SLA date (read-only)"},"realDelivery":{"type":"string","format":"date-time","description":"Real delivery date from DCIx (read-only)"},"slaSuspended":{"type":"string","description":"SLA suspended status from DCIx (read-only)"},"photoDocumentationTaken":{"type":"string","description":"Photo documentation status from DCIx (read-only)"},"deliveredPalletsCount":{"type":"number","description":"Number of delivered EUR pallets from DCIx (read-only)"},"deliveredCartonsCount":{"type":"number","description":"Number of delivered cartons from DCIx (read-only)"},"returnedEurPalletsCount":{"type":"number","description":"Number of returned EUR pallets from DCIx (read-only)"},"deliveredStandardPalletsCount":{"type":"number","description":"Number of delivered STANDARD pallets from DCIx (read-only)"},"returnedStandardPalletsCount":{"type":"number","description":"Number of returned STANDARD pallets from DCIx (read-only)"},"deliveredOtherPalletsCount":{"type":"number","description":"Number of delivered OTHER pallets from DCIx (read-only)"},"deliveredBrokenPalletsCount":{"type":"number","description":"Number of delivered BROKEN pallets from DCIx (read-only)"},"skladonNote":{"type":"string","description":"Skladon note (read-only)"},"unloadedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was unloaded (read-only)"},"receivedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving started processing (status received, read-only)"},"confirmedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was confirmed (read-only)"}}}]},"BaseReceiving":{"type":"object","properties":{"eshopReceivingId":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"trackingNumber":{"type":"string","minLength":1},"supplier":{"type":"string","minLength":1},"estimatedDelivery":{"type":"string","format":"date"},"deliveryNoteNumber":{"type":"string","minLength":1},"deliveryType":{"type":"string","enum":["courier","transportCompany","truckingCompany","container"]},"duty":{"type":"boolean"},"unitsAmount":{"type":"number","minimum":1},"driverCompany":{"type":"string"},"asnLabelEmail":{"type":"string","description":"Email address for sending ASN label"},"driverTrailerLicensePlate":{"type":"string"},"driverName":{"type":"string"},"driverPhone":{"type":"string"},"driverDispatcherContact":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"priority":{"type":"number","description":"Priority level (0=Normal, 1=High)","enum":[0,1],"default":0},"containerNumber":{"type":"string","description":"Container number for container transport"},"announcedPalletsCount":{"type":"number","description":"Number of announced pallets","minimum":0},"receivingType":{"type":"string","description":"Type of receiving","enum":["piece_mix","carton_single","carton_mix","pallet_single","pallet_mix"]},"incoterms":{"type":"string","description":"Delivery terms (Incoterms)","enum":["FOB","CPT","CIP","DPU","DAP","DDP"]}}},"ReceivingProductsResponse":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductResponse"}},"ReceivingProductResponse":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"received":{"type":"number","description":"Quantity of products received physically","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"serialNumber":{"type":"string","description":"Serial number of received product"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]},"packagings":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Model11"}},"Model11":{"type":"object","properties":{"packagingType":{"type":"string","enum":["non_returnable_pallet","returnable_pallet_wood","returnable_pallet_not_wood"]},"pallet":{"type":"string","enum":["pallet_100x120_ippc","pallet_100x120_standard","pallet_80x120_eur_a","pallet_80x120_eur_b","pallet_80x120_standard","pallet_60x80_ippc","pallet_60x80_standard","unspecified"]},"quantity":{"type":"number","minimum":1}},"required":["packagingType","quantity"]},"ReceivingFiles":{"type":"array","items":{"$ref":"#/components/schemas/ReceivingFileItem"}},"ReceivingFileItem":{"type":"object","description":"Receiving attachment (Core receivings_files + files).","properties":{"id":{"type":"integer","minimum":1,"description":"Existing file id; omit for new uploads"},"data":{"type":"string","description":"Base64 file payload; required for new files"},"type":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","minLength":1},"fileSize":{"type":"string"},"description":{"type":"string","maxLength":500},"creatorRole":{"type":"string","enum":["skladon_employee","client"]}},"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"]},"ReceivingPayload":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"products":{"$ref":"#/components/schemas/ReceivingProductsPayload"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","deliveryType","deliveryNoteNumber","containerNumber","announcedPalletsCount","duty","products","driverCompany","receivingType","trackingNumber"]}]},"ReceivingProductsPayload":{"type":"array","description":"If you dont send existing product in update it will be marked with disabled (lineState D)","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductPayload"}},"ReceivingProductPayload":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]}}},"paths":{"/receivings":{"post":{"summary":"Create receiving","operationId":"postReceivings","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":["Receivings"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivingResponseObject"}}}},"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/ReceivingPayload"}}}}}}}} ``` ## PUT /receivings/{eshopReceivingId} > Update receiving ```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":{"ReceivingResponseObject":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/ReceivingResponse"}},"required":["statusCode","message"]},"ReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceivingResponse"},{"type":"object","properties":{"asn":{"type":"string","description":"ASN number (read-only)"},"status":{"type":"string","enum":["awaiting","received","confirmed","canceled"]},"products":{"$ref":"#/components/schemas/ReceivingProductsResponse"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","products"]}]},"BaseReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"urgent":{"description":"Urgent status","type":"string","enum":["ok","afterUrgent","recievedWithoutAsn"]},"slaDate":{"type":"string","format":"date-time","description":"SLA date (read-only)"},"realDelivery":{"type":"string","format":"date-time","description":"Real delivery date from DCIx (read-only)"},"slaSuspended":{"type":"string","description":"SLA suspended status from DCIx (read-only)"},"photoDocumentationTaken":{"type":"string","description":"Photo documentation status from DCIx (read-only)"},"deliveredPalletsCount":{"type":"number","description":"Number of delivered EUR pallets from DCIx (read-only)"},"deliveredCartonsCount":{"type":"number","description":"Number of delivered cartons from DCIx (read-only)"},"returnedEurPalletsCount":{"type":"number","description":"Number of returned EUR pallets from DCIx (read-only)"},"deliveredStandardPalletsCount":{"type":"number","description":"Number of delivered STANDARD pallets from DCIx (read-only)"},"returnedStandardPalletsCount":{"type":"number","description":"Number of returned STANDARD pallets from DCIx (read-only)"},"deliveredOtherPalletsCount":{"type":"number","description":"Number of delivered OTHER pallets from DCIx (read-only)"},"deliveredBrokenPalletsCount":{"type":"number","description":"Number of delivered BROKEN pallets from DCIx (read-only)"},"skladonNote":{"type":"string","description":"Skladon note (read-only)"},"unloadedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was unloaded (read-only)"},"receivedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving started processing (status received, read-only)"},"confirmedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was confirmed (read-only)"}}}]},"BaseReceiving":{"type":"object","properties":{"eshopReceivingId":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"trackingNumber":{"type":"string","minLength":1},"supplier":{"type":"string","minLength":1},"estimatedDelivery":{"type":"string","format":"date"},"deliveryNoteNumber":{"type":"string","minLength":1},"deliveryType":{"type":"string","enum":["courier","transportCompany","truckingCompany","container"]},"duty":{"type":"boolean"},"unitsAmount":{"type":"number","minimum":1},"driverCompany":{"type":"string"},"asnLabelEmail":{"type":"string","description":"Email address for sending ASN label"},"driverTrailerLicensePlate":{"type":"string"},"driverName":{"type":"string"},"driverPhone":{"type":"string"},"driverDispatcherContact":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"priority":{"type":"number","description":"Priority level (0=Normal, 1=High)","enum":[0,1],"default":0},"containerNumber":{"type":"string","description":"Container number for container transport"},"announcedPalletsCount":{"type":"number","description":"Number of announced pallets","minimum":0},"receivingType":{"type":"string","description":"Type of receiving","enum":["piece_mix","carton_single","carton_mix","pallet_single","pallet_mix"]},"incoterms":{"type":"string","description":"Delivery terms (Incoterms)","enum":["FOB","CPT","CIP","DPU","DAP","DDP"]}}},"ReceivingProductsResponse":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductResponse"}},"ReceivingProductResponse":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"received":{"type":"number","description":"Quantity of products received physically","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"serialNumber":{"type":"string","description":"Serial number of received product"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]},"packagings":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Model11"}},"Model11":{"type":"object","properties":{"packagingType":{"type":"string","enum":["non_returnable_pallet","returnable_pallet_wood","returnable_pallet_not_wood"]},"pallet":{"type":"string","enum":["pallet_100x120_ippc","pallet_100x120_standard","pallet_80x120_eur_a","pallet_80x120_eur_b","pallet_80x120_standard","pallet_60x80_ippc","pallet_60x80_standard","unspecified"]},"quantity":{"type":"number","minimum":1}},"required":["packagingType","quantity"]},"ReceivingFiles":{"type":"array","items":{"$ref":"#/components/schemas/ReceivingFileItem"}},"ReceivingFileItem":{"type":"object","description":"Receiving attachment (Core receivings_files + files).","properties":{"id":{"type":"integer","minimum":1,"description":"Existing file id; omit for new uploads"},"data":{"type":"string","description":"Base64 file payload; required for new files"},"type":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","minLength":1},"fileSize":{"type":"string"},"description":{"type":"string","maxLength":500},"creatorRole":{"type":"string","enum":["skladon_employee","client"]}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ReceivingUpdatePayload":{"allOf":[{"$ref":"#/components/schemas/ReceivingPayload"},{"type":"object","properties":{"status":{"type":"string","description":"You can update only to canceled status, other statuses are not allowed. This field is optional.","enum":["canceled"]}}}]},"ReceivingPayload":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"products":{"$ref":"#/components/schemas/ReceivingProductsPayload"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","deliveryType","deliveryNoteNumber","containerNumber","announcedPalletsCount","duty","products","driverCompany","receivingType","trackingNumber"]}]},"ReceivingProductsPayload":{"type":"array","description":"If you dont send existing product in update it will be marked with disabled (lineState D)","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductPayload"}},"ReceivingProductPayload":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]}}},"paths":{"/receivings/{eshopReceivingId}":{"put":{"summary":"Update receiving","operationId":"putReceivingsEshopreceivingid","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":"eshopReceivingId","in":"path","required":true}],"tags":["Receivings"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivingResponseObject"}}}},"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/ReceivingUpdatePayload"}}}}}}}} ``` ## PATCH /receivings/{eshopReceivingId} > Partially update receiving ```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":{"ReceivingResponseObject":{"type":"object","properties":{"statusCode":{"type":"number","default":200},"message":{"type":"string"},"data":{"$ref":"#/components/schemas/ReceivingResponse"}},"required":["statusCode","message"]},"ReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceivingResponse"},{"type":"object","properties":{"asn":{"type":"string","description":"ASN number (read-only)"},"status":{"type":"string","enum":["awaiting","received","confirmed","canceled"]},"products":{"$ref":"#/components/schemas/ReceivingProductsResponse"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","products"]}]},"BaseReceivingResponse":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"urgent":{"description":"Urgent status","type":"string","enum":["ok","afterUrgent","recievedWithoutAsn"]},"slaDate":{"type":"string","format":"date-time","description":"SLA date (read-only)"},"realDelivery":{"type":"string","format":"date-time","description":"Real delivery date from DCIx (read-only)"},"slaSuspended":{"type":"string","description":"SLA suspended status from DCIx (read-only)"},"photoDocumentationTaken":{"type":"string","description":"Photo documentation status from DCIx (read-only)"},"deliveredPalletsCount":{"type":"number","description":"Number of delivered EUR pallets from DCIx (read-only)"},"deliveredCartonsCount":{"type":"number","description":"Number of delivered cartons from DCIx (read-only)"},"returnedEurPalletsCount":{"type":"number","description":"Number of returned EUR pallets from DCIx (read-only)"},"deliveredStandardPalletsCount":{"type":"number","description":"Number of delivered STANDARD pallets from DCIx (read-only)"},"returnedStandardPalletsCount":{"type":"number","description":"Number of returned STANDARD pallets from DCIx (read-only)"},"deliveredOtherPalletsCount":{"type":"number","description":"Number of delivered OTHER pallets from DCIx (read-only)"},"deliveredBrokenPalletsCount":{"type":"number","description":"Number of delivered BROKEN pallets from DCIx (read-only)"},"skladonNote":{"type":"string","description":"Skladon note (read-only)"},"unloadedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was unloaded (read-only)"},"receivedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving started processing (status received, read-only)"},"confirmedAt":{"type":"string","format":"date-time","description":"Date and time when the receiving was confirmed (read-only)"}}}]},"BaseReceiving":{"type":"object","properties":{"eshopReceivingId":{"type":"string","minLength":1},"description":{"type":"string","minLength":1},"trackingNumber":{"type":"string","minLength":1},"supplier":{"type":"string","minLength":1},"estimatedDelivery":{"type":"string","format":"date"},"deliveryNoteNumber":{"type":"string","minLength":1},"deliveryType":{"type":"string","enum":["courier","transportCompany","truckingCompany","container"]},"duty":{"type":"boolean"},"unitsAmount":{"type":"number","minimum":1},"driverCompany":{"type":"string"},"asnLabelEmail":{"type":"string","description":"Email address for sending ASN label"},"driverTrailerLicensePlate":{"type":"string"},"driverName":{"type":"string"},"driverPhone":{"type":"string"},"driverDispatcherContact":{"type":"string"},"eshopNote":{"type":"string","description":"Note from e-shop that is not shown to the customer"},"priority":{"type":"number","description":"Priority level (0=Normal, 1=High)","enum":[0,1],"default":0},"containerNumber":{"type":"string","description":"Container number for container transport"},"announcedPalletsCount":{"type":"number","description":"Number of announced pallets","minimum":0},"receivingType":{"type":"string","description":"Type of receiving","enum":["piece_mix","carton_single","carton_mix","pallet_single","pallet_mix"]},"incoterms":{"type":"string","description":"Delivery terms (Incoterms)","enum":["FOB","CPT","CIP","DPU","DAP","DDP"]}}},"ReceivingProductsResponse":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductResponse"}},"ReceivingProductResponse":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"received":{"type":"number","description":"Quantity of products received physically","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"serialNumber":{"type":"string","description":"Serial number of received product"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]},"packagings":{"type":"array","minItems":0,"items":{"$ref":"#/components/schemas/Model11"}},"Model11":{"type":"object","properties":{"packagingType":{"type":"string","enum":["non_returnable_pallet","returnable_pallet_wood","returnable_pallet_not_wood"]},"pallet":{"type":"string","enum":["pallet_100x120_ippc","pallet_100x120_standard","pallet_80x120_eur_a","pallet_80x120_eur_b","pallet_80x120_standard","pallet_60x80_ippc","pallet_60x80_standard","unspecified"]},"quantity":{"type":"number","minimum":1}},"required":["packagingType","quantity"]},"ReceivingFiles":{"type":"array","items":{"$ref":"#/components/schemas/ReceivingFileItem"}},"ReceivingFileItem":{"type":"object","description":"Receiving attachment (Core receivings_files + files).","properties":{"id":{"type":"integer","minimum":1,"description":"Existing file id; omit for new uploads"},"data":{"type":"string","description":"Base64 file payload; required for new files"},"type":{"type":"string","minLength":1},"fileName":{"type":"string","minLength":1},"fileType":{"type":"string","minLength":1},"fileSize":{"type":"string"},"description":{"type":"string","maxLength":500},"creatorRole":{"type":"string","enum":["skladon_employee","client"]}},"required":["type","fileName","fileType"]},"ErrorMessageResponse":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ReceivingUpdatePayload":{"allOf":[{"$ref":"#/components/schemas/ReceivingPayload"},{"type":"object","properties":{"status":{"type":"string","description":"You can update only to canceled status, other statuses are not allowed. This field is optional.","enum":["canceled"]}}}]},"ReceivingPayload":{"allOf":[{"$ref":"#/components/schemas/BaseReceiving"},{"type":"object","properties":{"products":{"$ref":"#/components/schemas/ReceivingProductsPayload"},"packagings":{"$ref":"#/components/schemas/packagings"},"files":{"$ref":"#/components/schemas/ReceivingFiles"}},"required":["eshopReceivingId","estimatedDelivery","unitsAmount","deliveryType","deliveryNoteNumber","containerNumber","announcedPalletsCount","duty","products","driverCompany","receivingType","trackingNumber"]}]},"ReceivingProductsPayload":{"type":"array","description":"If you dont send existing product in update it will be marked with disabled (lineState D)","minItems":1,"items":{"$ref":"#/components/schemas/ReceivingProductPayload"}},"ReceivingProductPayload":{"type":"object","properties":{"sku":{"type":"string"},"quantity":{"type":"number","description":"Quantity of products to be received","minimum":1},"lot":{"type":"string","minLength":1},"expirationDate":{"type":"string","format":"date"},"productPrice":{"type":"number"},"lineState":{"type":"string","description":"E for enabled, D for disabled","default":"E","enum":["E","D"]}},"required":["sku","quantity","lineState"]}}},"paths":{"/receivings/{eshopReceivingId}":{"patch":{"summary":"Partially update receiving","operationId":"patchReceivingsEshopreceivingid","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":"eshopReceivingId","in":"path","required":true}],"tags":["Receivings"],"responses":{"200":{"description":"Success response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivingResponseObject"}}}},"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/ReceivingUpdatePayload"}}}}}}}} ``` --- # 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/receivings.md?ask=&goal= ``` `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.