{"components":{"examples":{},"headers":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"ErrorDetails":{"properties":{"field":{"type":"string","description":"Name of the request value which caused the error","example":"field_id"},"message":{"type":"string","description":"Reason of the value violation","example":"not valid"}},"required":["field","message"],"type":"object","additionalProperties":false},"ProblemType":{"enum":["about:blank","/problems/bad-request","/problems/not-found","/problems/forbidden","/problems/unauthorized","/problems/server-error","/problems/service-unavailable","/problems/validation-error","/problems/storefront-not-configured","/problems/invalid-credentials","/problems/corrupted-signature","/problems/inactive-account","/problems/missing-or-invalid-request-header","/problems/duplicate-action","/problems/action-not-allowed","/problems/tickets/internal-action-restriction","/problems/tickets/fbk-action-restriction","/problems/tickets/non-closable-by-seller","/problems/tickets/finally-closed","/problems/tickets/attachments-upload-failure","/problems/insufficient-funds","/problems/returns/unit-wrong-status","/problems/returns/return-address-not-set","/problems/returns/return-address-unsupported-country","/problems/order-units/cancel-error","/problems/order-units/cancel-not-possible","/problems/order-units/cancel-not-allowed","/problems/order-units/missing-payment","/problems/order-units/shipping-rate-not-defined","/problems/subscriptions/unverified-callback-url","/problems/already-exists","/problems/has-units","/problems/last-element","/problems/default-required","/problems/units/bulk-duplicate-units","/problems/units/bulk-too-many-units","/problems/units/bulk-invalid-operation","/problems/units/bulk-too-many-butches","/problems/shipping-groups/region-storefront-missing","/problems/shipping-groups/region-duplicate-countries","/problems/warehouses/missing-tax-information","/problems/warehouses/default-warehouse-setup-forbidden","/problems/import-files/file-too-large","/problems/shipping-labels/warehouse-missing"],"type":"string"},"ErrorResponse":{"properties":{"type":{"$ref":"#/components/schemas/ProblemType"},"errors":{"items":{"$ref":"#/components/schemas/ErrorDetails"},"type":"array"},"message":{"type":"string"}},"required":["errors","message"],"type":"object"},"ExternalDemandIndicator":{"enum":["Very low","Low","Medium","High","Very high","NA"],"type":"string"},"Currency":{"enum":["EUR","CZK","PLN"],"type":"string"},"AssortmentInsight":{"properties":{"ean":{"type":"string"},"item_name":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"category":{"type":"string","nullable":true},"category_2":{"type":"string","nullable":true},"buybox_price_l_90_day":{"type":"integer","format":"int32","nullable":true},"buybox_price_l_60_day":{"type":"integer","format":"int32","nullable":true},"buybox_price_l_30_day":{"type":"integer","format":"int32","nullable":true},"buybox_price_current":{"type":"integer","format":"int32","nullable":true},"sales_rank":{"type":"integer","format":"int32","nullable":true},"external_rank":{"type":"integer","format":"int32","nullable":true},"external_demand_indicator":{"allOf":[{"$ref":"#/components/schemas/ExternalDemandIndicator"}],"nullable":true},"benchmark_price_min":{"type":"integer","format":"int32","nullable":true},"benchmark_price_max":{"type":"integer","format":"int32","nullable":true},"external_bestseller_missed":{"type":"boolean"},"popular_product_bad_priced":{"type":"boolean"},"kaufland_bestseller":{"type":"boolean"},"currency":{"$ref":"#/components/schemas/Currency"}},"required":["ean","item_name","brand","category","category_2","buybox_price_l_90_day","buybox_price_l_60_day","buybox_price_l_30_day","buybox_price_current","sales_rank","external_rank","external_demand_indicator","benchmark_price_min","benchmark_price_max","external_bestseller_missed","popular_product_bad_priced","kaufland_bestseller","currency"],"type":"object","additionalProperties":false},"Pagination":{"properties":{"offset":{"type":"integer","format":"int32","example":30},"limit":{"type":"integer","format":"int32","example":10},"total":{"type":"integer","format":"int32","example":200}},"required":["offset","limit","total"],"type":"object","additionalProperties":false},"CollectionApiResponse_AssortmentInsight_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AssortmentInsight"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"CreateShippingLabelResponse":{"properties":{"id":{"type":"string","example":"313a1a22-c9a2-4688-994e-a5d59866fd08"},"tracking_number":{"type":"string","example":"ABCDEFGH"},"carrier":{"type":"string","example":"GLS"},"download_url":{"type":"string","example":"https://example.com/path/to/shippinglabel.pdf"}},"required":["id","tracking_number","carrier","download_url"],"type":"object","additionalProperties":false},"ApiResponse_CreateShippingLabelResponse_":{"properties":{"data":{"$ref":"#/components/schemas/CreateShippingLabelResponse"}},"required":["data"],"type":"object","additionalProperties":false},"LongInteger":{"type":"integer","format":"int64"},"Integer":{"type":"integer","format":"int32"},"PackageMeasurements":{"properties":{"weight_gram":{"$ref":"#/components/schemas/Integer"},"height_cm":{"$ref":"#/components/schemas/Integer"},"length_cm":{"$ref":"#/components/schemas/Integer"},"width_cm":{"$ref":"#/components/schemas/Integer"}},"required":["weight_gram","height_cm","length_cm","width_cm"],"type":"object","additionalProperties":false},"CreateShippingLabelRequest":{"properties":{"ids_order_units":{"items":{"$ref":"#/components/schemas/LongInteger"},"type":"array"},"carriers":{"items":{"type":"string"},"type":"array"},"package_measurements":{"$ref":"#/components/schemas/PackageMeasurements"}},"required":["ids_order_units","carriers","package_measurements"],"type":"object","additionalProperties":false},"VatIndicator":{"enum":["standard_rate","reduced_rate_1","reduced_rate_2","super_reduced_rate","zero_rate","unspecified"],"type":"string"},"VatRate":{"properties":{"vat_indicator":{"$ref":"#/components/schemas/VatIndicator","example":"standard_rate"},"value":{"type":"number","format":"float","example":19}},"required":["vat_indicator","value"],"type":"object","additionalProperties":false},"CountryVatRates":{"properties":{"storefront":{"type":"string","example":"de"},"vat_rates":{"items":{"$ref":"#/components/schemas/VatRate"},"type":"array"}},"required":["storefront","vat_rates"],"type":"object","additionalProperties":false},"ApiResponse_CountryVatRates-Array_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CountryVatRates"},"type":"array"}},"required":["data"],"type":"object","additionalProperties":false},"Storefront":{"enum":["de","cz","sk","pl","at","fr","it"],"type":"string"},"createdOrder":{"properties":{"id_order":{"type":"string","example":123456789}},"required":["id_order"],"type":"object","additionalProperties":false},"BaseCollectionApiResponse_createdOrder_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/createdOrder"},"type":"array"},"total":{"type":"number","format":"double"}},"required":["data","total"],"type":"object","additionalProperties":false},"UnitsDetails":{"properties":{"id_item_unit":{"type":"string","example":123456789},"amount":{"type":"integer","format":"int32","minimum":1}},"required":["id_item_unit","amount"],"type":"object","additionalProperties":false},"createCollectionInput_UnitsDetails_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UnitsDetails"},"type":"array"}},"required":["data"],"type":"object","additionalProperties":false},"BuyboxCondition":{"enum":["new","used","used - as new","used - very good","used - good","used - acceptable","refurbished","refurbished - as new","refurbished - very good","refurbished - good","refurbished - acceptable"],"type":"string"},"FulfillmentType":{"enum":["fulfilled_by_kaufland","fulfilled_by_merchant"],"type":"string"},"BuyboxUnit":{"properties":{"buybox_rank":{"type":"number","format":"double","description":"The rank of the offer in the buybox"},"seller":{"type":"string","description":"The seller name"},"price":{"type":"number","format":"double","description":"The price listed in the marketplace in the currency of the storefront"},"delivery_time_min":{"type":"number","format":"double"},"delivery_time_max":{"type":"number","format":"double"},"shipping_rate":{"type":"number","format":"double"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType"},"id_unit":{"type":"integer","format":"int64","description":"Internal ID of Unit, unique across all Units.\nThis property is only visible when you are the owner of the unit.","minimum":1},"id_offer":{"type":"string","nullable":true,"description":"Seller's unique ID for offer(s).\nThis property is only visible when you are the owner of the unit."}},"required":["buybox_rank","seller","price","delivery_time_min","delivery_time_max","shipping_rate","fulfillment_type"],"type":"object","additionalProperties":false},"OffersRankings":{"properties":{"id_product":{"type":"integer","format":"int64","description":"Internal ID of Product, unique across all Products"},"condition":{"$ref":"#/components/schemas/BuyboxCondition","description":"Condition of the offers to be filtered"},"storefront":{"$ref":"#/components/schemas/Storefront"},"num_units":{"type":"number","format":"double","description":"Total number of offers for the given product"},"units":{"items":{"$ref":"#/components/schemas/BuyboxUnit"},"type":"array"}},"required":["id_product","condition","storefront","num_units","units"],"type":"object","additionalProperties":false},"ApiResponse_OffersRankings_":{"properties":{"data":{"$ref":"#/components/schemas/OffersRankings"}},"required":["data"],"type":"object","additionalProperties":false},"ProductCategoriesImportFileStatus":{"enum":["NEW","DOWNLOADING","DOWNLOADED","DOWNLOADING_FAILED","PREPARING","PREPARED","PREPARING_FAILED","CHECKING","CHECKED","CHECKING_FAILED","PREPROCESSING","PREPROCESSED","PREPROCESSING_FAILED","IMPORTING","IMPORTED","IMPORTING_FAILED","IMPORTING_STOPPED","ERROR","ABORTED","DONE"],"type":"string"},"ProductCategoriesImportFileResponse":{"properties":{"id_import_file":{"type":"integer","format":"int64","minimum":1},"uri":{"type":"string"},"status":{"$ref":"#/components/schemas/ProductCategoriesImportFileStatus"},"note":{"type":"string","nullable":true},"total_lines":{"type":"number","format":"double"},"current_line":{"type":"number","format":"double"},"ts_created":{"type":"string"},"ts_updated":{"type":"string","nullable":true},"ts_last_row_updated":{"type":"string","nullable":true},"ts_completed":{"type":"string","nullable":true},"error_count":{"type":"number","format":"double"},"async_import_done":{"type":"number","format":"double"}},"required":["id_import_file","uri","status","note","total_lines","current_line","ts_created","ts_updated","ts_last_row_updated","ts_completed","error_count","async_import_done"],"type":"object","additionalProperties":false},"CollectionApiResponse_ProductCategoriesImportFileResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductCategoriesImportFileResponse"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ProductCategoriesImportFileSorting":{"enum":["ts_created:asc","ts_updated:asc","ts_created:desc","ts_updated:desc"],"type":"string"},"ApiResponse_ProductCategoriesImportFileResponse_":{"properties":{"data":{"$ref":"#/components/schemas/ProductCategoriesImportFileResponse"}},"required":["data"],"type":"object","additionalProperties":false},"NotFoundResponse":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object","additionalProperties":false},"ProductCategoriesImportFileRequestBody":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object","additionalProperties":false},"InfoLocaleObject":{"items":{"type":"string"},"type":"array"},"ApiResponse_InfoLocaleObject_":{"properties":{"data":{"$ref":"#/components/schemas/InfoLocaleObject"}},"required":["data"],"type":"object","additionalProperties":false},"ApiResponse_string-Array_":{"properties":{"data":{"items":{"type":"string"},"type":"array"}},"required":["data"],"type":"object","additionalProperties":false},"Category":{"properties":{"name":{"type":"string"},"title_singular":{"type":"string"},"title_plural":{"type":"string"},"level":{"type":"number","format":"double"},"url":{"type":"string"},"is_leaf":{"type":"boolean"},"id_category":{"type":"integer","format":"int64","minimum":1},"id_parent_category":{"type":"integer","format":"int64","minimum":1},"shipping_category":{"type":"string"},"variable_fee":{"type":"number","format":"double"},"fixed_fee":{"type":"number","format":"double"},"vat":{"type":"number","format":"double"}},"required":["name","title_singular","title_plural","level","url","is_leaf","id_category","id_parent_category","shipping_category","variable_fee","fixed_fee","vat"],"type":"object","additionalProperties":false},"CategoryBasic":{"properties":{"name":{"type":"string"},"title_singular":{"type":"string"},"title_plural":{"type":"string"},"level":{"type":"number","format":"double"},"url":{"type":"string"},"is_leaf":{"type":"boolean"},"id_category":{"type":"integer","format":"int64","minimum":1}},"required":["name","title_singular","title_plural","level","url","is_leaf","id_category"],"type":"object","additionalProperties":false},"UnitCondition":{"enum":["USED___ACCEPTABLE","USED___VERY_GOOD","USED___AS_NEW","USED___GOOD","NEW","REFURBISHED___VERY_GOOD","REFURBISHED___GOOD","REFURBISHED___AS_NEW","REFURBISHED___ACCEPTABLE"],"type":"string"},"ProductUnitEmbeddedSeller":{"properties":{"pseudonym":{"type":"string"}},"required":["pseudonym"],"type":"object","additionalProperties":false},"ProductUnitEmbedded":{"description":"Used only for swagger documentation. Actual response comes from the shop api response","properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"id_product":{"type":"integer","format":"int64","minimum":1},"condition":{"$ref":"#/components/schemas/UnitCondition"},"location":{"type":"string","nullable":true,"description":"Warehouse location"},"warehouse":{"type":"string","nullable":true,"description":"Warehouse name"},"amount":{"type":"integer","format":"int32","default":"1","minimum":0},"price":{"type":"integer","format":"int32","description":"Price at which this unit will be offered on Kaufland.de","minimum":1},"delivery_time_min":{"type":"integer","format":"int32","minimum":1},"delivery_time_max":{"type":"integer","format":"int32","minimum":1},"shipping_group":{"type":"string","nullable":true,"description":"Shipping group name"},"note":{"type":"string","nullable":true,"description":"A note for this unit"},"seller":{"allOf":[{"$ref":"#/components/schemas/ProductUnitEmbeddedSeller"}],"nullable":true,"description":"Seller pseudonym for the unit"},"reference_price":{"type":"integer","format":"int32","nullable":true,"minimum":1},"shipping_rate":{"type":"integer","format":"int32","minimum":0},"date_inserted":{"type":"string","format":"date-time"},"date_lastchange":{"type":"string","format":"date-time","nullable":true},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType"}},"required":["id_unit","id_product","condition","location","warehouse","amount","price","delivery_time_min","delivery_time_max","shipping_group","note","seller","reference_price","shipping_rate","date_inserted","date_lastchange","fulfillment_type"],"type":"object","additionalProperties":false},"ProductWithEmbedded":{"properties":{"id_product":{"type":"integer","format":"int64","example":362524873,"minimum":1},"storefront":{"$ref":"#/components/schemas/Storefront","example":"DE"},"title":{"type":"string","example":"Apple iPhone 12 mini 64GB Schwarz"},"eans":{"items":{"type":"string"},"type":"array","example":["0194252013212","194252013212","0194252012925"]},"id_category":{"type":"integer","format":"int64","example":34401,"minimum":1},"main_picture":{"type":"string","example":"https://media.cdn.kaufland.de/product-images/2048x2048/7ddfbf37e8c5d3137179e1361c432246.jpg"},"manufacturer":{"type":"string","example":"Apple"},"url":{"type":"string","example":"https://www.kaufland.de/product/362524873/"},"age_rating":{"type":"number","format":"double","example":0},"is_valid":{"type":"boolean","example":true},"dangerous_goods_li_shipping":{"type":"string","nullable":true,"example":"UN 3090"},"danger_label_9A":{"type":"string","nullable":true,"example":"Nein"},"category":{"$ref":"#/components/schemas/Category"},"category_basic":{"$ref":"#/components/schemas/CategoryBasic"},"units":{"items":{"$ref":"#/components/schemas/ProductUnitEmbedded"},"type":"array"}},"required":["id_product","storefront","title","eans","id_category","main_picture","manufacturer","url","age_rating","is_valid","dangerous_goods_li_shipping","danger_label_9A"],"type":"object","additionalProperties":false},"ApiResponse_ProductWithEmbedded_":{"properties":{"data":{"$ref":"#/components/schemas/ProductWithEmbedded"}},"required":["data"],"type":"object","additionalProperties":false},"ProductEmbeddable":{"enum":["category","category_basic","units"],"type":"string"},"Order":{"properties":{"id_order":{"type":"string","example":"MB7UWLD"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"is_marketplace_deemed_supplier":{"type":"boolean","example":"true"},"order_units_count":{"$ref":"#/components/schemas/Integer","example":3},"ts_units_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"}},"required":["id_order","ts_created_iso","is_marketplace_deemed_supplier","order_units_count","ts_units_updated_iso","storefront","fulfillment_type"],"type":"object","additionalProperties":false},"CollectionApiResponse_Order_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"OrderUnitStatus":{"enum":["cancelled","need_to_be_sent","open","received","returned","returned_paid","sent","sent_and_autopaid"],"type":"string"},"Product":{"properties":{"id_product":{"type":"integer","format":"int64","example":362524873,"minimum":1},"storefront":{"$ref":"#/components/schemas/Storefront","example":"DE"},"title":{"type":"string","example":"Apple iPhone 12 mini 64GB Schwarz"},"eans":{"items":{"type":"string"},"type":"array","example":["0194252013212","194252013212","0194252012925"]},"id_category":{"type":"integer","format":"int64","example":34401,"minimum":1},"main_picture":{"type":"string","example":"https://media.cdn.kaufland.de/product-images/2048x2048/7ddfbf37e8c5d3137179e1361c432246.jpg"},"manufacturer":{"type":"string","example":"Apple"},"url":{"type":"string","example":"https://www.kaufland.de/product/362524873/"},"age_rating":{"type":"number","format":"double","example":0},"is_valid":{"type":"boolean","example":true},"dangerous_goods_li_shipping":{"type":"string","nullable":true,"example":"UN 3090"},"danger_label_9A":{"type":"string","nullable":true,"example":"Nein"}},"required":["id_product","storefront","title","eans","id_category","main_picture","manufacturer","url","age_rating","is_valid","dangerous_goods_li_shipping","danger_label_9A"],"type":"object","additionalProperties":false},"TicketID":{"type":"string","example":"0011234567","description":"Unique id of the ticket.","pattern":"^001\\d+$"},"TicketStatus":{"enum":["opened","buyer_closed","seller_closed","both_closed","customer_service_closed_final"],"type":"string"},"TicketReason":{"enum":["product_not_as_described","product_defect","product_not_delivered","product_return","contact_other"],"type":"string"},"TicketTopic":{"enum":["order_cancel","order_product_defect","order_other_question","delivery_not_received","delivery_delayed","delivery_wrong_products","delivery_parts_missing","delivery_change_address","delivery_to_store","delivery_other_question","return_check_status","return_request_label","issue_paypal","issue_klarna","issue_creditcard","issue_sofort","issue_consorsfinanz","issue_cashinadvance","issue_payback","issue_barzahlen","issue_coupon","invoice_needed","admonition","account_newsletter","account_login","account_cancel","account_other","account_age_verification","product_properties","product_availability","product_other_question","account_cash_out_balance","old_device_take_back","other_question","fraud","issue_googlepay","issue_applepay","issue_click_to_pay","invoice_problem","issue_blik","kaufland_card","cs_nagative_rating"],"type":"string"},"Ticket":{"properties":{"id_ticket":{"$ref":"#/components/schemas/TicketID","example":"0011234567"},"ids_order_units":{"items":{"$ref":"#/components/schemas/LongInteger"},"type":"array","description":"The list of order units IDs","example":[123456789,987654321]},"id_buyer":{"allOf":[{"$ref":"#/components/schemas/LongInteger"}],"nullable":true,"example":123456789},"ts_created_iso":{"type":"string","format":"date-time","description":"Creation date of the ticket in iso 8601","example":"2021-07-24T19:26:05Z"},"ts_updated_iso":{"type":"string","format":"date-time","description":"Last update on the ticket in iso 8601","example":"2021-07-24T19:26:05Z"},"status":{"$ref":"#/components/schemas/TicketStatus","description":"The status of the ticket","example":"opened"},"open_reason":{"$ref":"#/components/schemas/TicketReason","description":"Reason why the ticket was opened","example":"product_not_delivered"},"topic":{"allOf":[{"$ref":"#/components/schemas/TicketTopic"}],"nullable":true,"description":"The topic of the ticket","example":"delivery_not_received"},"is_seller_responsible":{"type":"boolean","description":"An indicator, whether the seller needs to take action","example":false},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","description":"Fulfillment type"}},"required":["id_ticket","ids_order_units","id_buyer","ts_created_iso","ts_updated_iso","status","open_reason","topic","is_seller_responsible","fulfillment_type"],"type":"object","additionalProperties":false},"Address":{"properties":{"first_name":{"type":"string","description":"Address holders' first name","example":"Tom"},"last_name":{"type":"string","description":"Address holders' last name","example":"Smith"},"company_name":{"type":"string","nullable":true,"description":"Address holders' company name","example":"Smith Holding GmBH"},"street":{"type":"string","description":"Address holders' street","example":"Test Ln."},"house_number":{"type":"string","description":"Address holders' house number","example":"1"},"postcode":{"type":"string","description":"Address holders' post code","example":"12345"},"additional_field":{"type":"string","nullable":true,"description":"Any additional information","example":"something"},"city":{"type":"string","description":"Address holders' city","example":"New York"},"phone":{"type":"string","nullable":true,"description":"Address holders' phone number","example":"+491234567"},"country":{"type":"string","description":"Address holders' country","example":"USA"}},"required":["first_name","last_name","company_name","street","house_number","postcode","additional_field","city","phone","country"],"type":"object","additionalProperties":false},"Buyer":{"properties":{"id_buyer":{"$ref":"#/components/schemas/LongInteger","description":"Unique ID of the buyer","example":21631426},"email":{"type":"string","nullable":true,"description":"The email of the buyer","example":"buyer@dev.com"}},"required":["id_buyer","email"],"type":"object","additionalProperties":false},"OrderInvoice":{"properties":{"id_invoice":{"$ref":"#/components/schemas/LongInteger","example":918273645},"id_order":{"type":"string","example":"MB7UWLD"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"is_marketplace_deemed_supplier":{"type":"boolean","example":false},"original_name":{"type":"string","example":"invoice_MB7UWLD.pdf"},"mime_type":{"type":"string","example":"application/pdf"},"url":{"type":"string","example":"https://kaufland.de/dynamic/files/order_invoices/918273645/?access_token=f31ac55d337500edff7be20ae14e0bf3"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"}},"required":["id_invoice","id_order","storefront","is_marketplace_deemed_supplier","original_name","mime_type","url","ts_created_iso"],"type":"object","additionalProperties":false},"PickupLocation":{"properties":{"pickup_location_id":{"type":"string","description":"The unique identifier for the pickup location. (Also known as branch ID)\nFor Packeta this is a numeric string, but for other carriers it may have a different format.","example":"260"},"provider":{"type":"string","description":"Identifies the provider of the pickup location.","example":"DHL"},"carrier":{"type":"string","description":"Specifies the carrier responsible for delivering the order to the pickup location.\nIn some instances, the carrier may be different from the provider.","example":"DHL"},"services":{"type":"string","description":"Describes the delivery services associated with the pickup location delivery (e.g., \"inpost_locker_standard\" for deliveries to InPost pickup locations). For Packeta this is going to be always an empty string.\nServices is a reserved field that Packeta did not implement it yet:\nhttps://docs.packetery.com/03-creating-packets/06-packetery-api-reference.html#toc-services\nFor PPL it would be a CSV like \"COD, PPCK\"."},"dhl_post_number":{"type":"string","nullable":true,"description":"This field contains the DHL post number (Postnummer) for deliveries to DHL Packstations.\nThis field is nullable and will only contain data for DHL deliveries.","example":"999999999999"}},"required":["pickup_location_id","provider","carrier","services","dhl_post_number"],"type":"object","additionalProperties":false},"Delivery":{"properties":{"pickup_location":{"allOf":[{"$ref":"#/components/schemas/PickupLocation"}],"nullable":true}},"required":["pickup_location"],"type":"object","additionalProperties":false},"OrderDetails":{"properties":{"id_order":{"type":"string","example":"MB7UWLD"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"is_marketplace_deemed_supplier":{"type":"boolean","example":"true"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"order_units":{"items":{"properties":{"kss_eligible":{"type":"boolean","description":"The attribute is only responded when explicitly requested as an embedded field","example":true},"tickets":{"items":{"$ref":"#/components/schemas/Ticket"},"type":"array","nullable":true},"vat":{"type":"number","format":"float","nullable":true,"example":19},"product":{"allOf":[{"$ref":"#/components/schemas/Product"}],"nullable":true},"cancel_reason":{"type":"string","nullable":true,"example":"BuyerCancelled"},"shipping_rate":{"$ref":"#/components/schemas/Integer","example":390},"order_received_timestamp_iso":{"type":"string","format":"date-time","nullable":true,"example":"2021-07-26T11:13:14Z"},"delivery_time_expires_iso":{"type":"string","format":"date-time","nullable":true,"example":"2021-07-28T12:13:14Z"},"delivery_time_max":{"type":"integer","format":"int32","nullable":true,"example":6},"delivery_time_min":{"allOf":[{"$ref":"#/components/schemas/Integer"}],"nullable":true,"example":3},"currency":{"$ref":"#/components/schemas/Currency","example":"EUR"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"DE"},"unit_condition":{"type":"string","nullable":true,"example":"new"},"note":{"type":"string","nullable":true,"example":"Some note"},"revenue_net":{"$ref":"#/components/schemas/Integer","example":3400},"revenue_gross":{"$ref":"#/components/schemas/Integer","example":5900},"id_offer":{"type":"string","nullable":true,"example":"AB-120"},"price":{"$ref":"#/components/schemas/Integer","example":200},"status":{"$ref":"#/components/schemas/OrderUnitStatus","example":"sent"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"is_marketplace_deemed_supplier":{"type":"boolean","example":"false"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"id_order":{"type":"string","example":"MB7UWLD"},"id_order_unit":{"$ref":"#/components/schemas/LongInteger","example":314567896580917}},"required":["tickets","vat","product","cancel_reason","shipping_rate","order_received_timestamp_iso","delivery_time_expires_iso","delivery_time_max","delivery_time_min","currency","storefront","unit_condition","note","revenue_net","revenue_gross","id_offer","price","status","ts_updated_iso","is_marketplace_deemed_supplier","ts_created_iso","id_order","id_order_unit"],"type":"object"},"type":"array"},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"buyer":{"allOf":[{"$ref":"#/components/schemas/Buyer"}],"nullable":true},"order_invoices":{"items":{"$ref":"#/components/schemas/OrderInvoice"},"type":"array","nullable":true},"delivery":{"$ref":"#/components/schemas/Delivery","description":"The attribute is only responded when explicitly requested as an embedded field"}},"required":["id_order","ts_created_iso","is_marketplace_deemed_supplier","storefront","fulfillment_type","order_units","billing_address","shipping_address","buyer"],"type":"object","additionalProperties":false},"ApiResponse_OrderDetails_":{"properties":{"data":{"$ref":"#/components/schemas/OrderDetails"}},"required":["data"],"type":"object","additionalProperties":false},"OrderEmbeddable":{"description":"Additional data to be returned for order","enum":["order_invoices","delivery","kss_delivery"],"type":"string"},"OrderUnit":{"properties":{"id_order_unit":{"$ref":"#/components/schemas/LongInteger","example":314567896580917},"id_order":{"type":"string","example":"MB7UWLD"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"is_marketplace_deemed_supplier":{"type":"boolean"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"status":{"$ref":"#/components/schemas/OrderUnitStatus","example":"sent"},"price":{"$ref":"#/components/schemas/Integer","example":200},"id_offer":{"type":"string","nullable":true,"example":"AB-120"},"revenue_gross":{"$ref":"#/components/schemas/Integer","example":5900},"revenue_net":{"$ref":"#/components/schemas/Integer","example":3400},"note":{"type":"string","nullable":true,"example":"Some note"},"unit_condition":{"type":"string","nullable":true,"example":"new"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"DE"},"currency":{"$ref":"#/components/schemas/Currency","example":"EUR"},"delivery_time_min":{"allOf":[{"$ref":"#/components/schemas/Integer"}],"nullable":true,"example":3},"delivery_time_max":{"allOf":[{"$ref":"#/components/schemas/Integer"}],"nullable":true,"example":6},"delivery_time_expires_iso":{"type":"string","format":"date-time","nullable":true,"example":"2021-07-28T12:13:14Z"},"order_received_timestamp_iso":{"type":"string","format":"date-time","nullable":true,"example":"2021-07-26T11:13:14Z"},"shipping_rate":{"$ref":"#/components/schemas/Integer","example":390},"cancel_reason":{"type":"string","nullable":true,"example":"BuyerCancelled"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"buyer":{"allOf":[{"$ref":"#/components/schemas/Buyer"}],"nullable":true},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"product":{"allOf":[{"$ref":"#/components/schemas/Product"}],"nullable":true},"vat":{"type":"number","format":"float","nullable":true,"example":19},"eco_fee":{"type":"integer","format":"int32","nullable":true,"example":1900},"packaging_fee":{"type":"integer","format":"int32","nullable":true,"example":1950}},"required":["id_order_unit","id_order","ts_created_iso","is_marketplace_deemed_supplier","ts_updated_iso","status","price","id_offer","revenue_gross","revenue_net","note","unit_condition","storefront","currency","delivery_time_min","delivery_time_max","delivery_time_expires_iso","order_received_timestamp_iso","shipping_rate","cancel_reason","fulfillment_type","buyer","billing_address","shipping_address","product","vat"],"type":"object","additionalProperties":false},"CollectionApiResponse_OrderUnit_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrderUnit"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ReturnUnitStatus":{"enum":["need_to_be_returned","return_arrived","return_accepted","return_rejected","return_closed","return_in_repair","return_in_clarification"],"type":"string"},"ReturnReason":{"enum":["accidentally_ordered","bad_quality","better_price","defect","delivered_damaged","dislike","misleading_description","missing_parts","no_reason","too_late","wrong_article","wrong_size"],"type":"string"},"ReturnUnit":{"properties":{"id_return_unit":{"$ref":"#/components/schemas/LongInteger","example":45456767},"id_return":{"$ref":"#/components/schemas/LongInteger","example":23234545},"id_order_unit":{"$ref":"#/components/schemas/LongInteger","description":"678912345"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"status":{"$ref":"#/components/schemas/ReturnUnitStatus","example":"return_arrived"},"note":{"type":"string","nullable":true,"example":"Some note"},"reason":{"$ref":"#/components/schemas/ReturnReason","example":"wrong_article"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"}},"required":["id_return_unit","id_return","id_order_unit","ts_created_iso","status","note","reason","storefront","fulfillment_type"],"type":"object","additionalProperties":false},"OrderUnitDetails":{"properties":{"id_order_unit":{"$ref":"#/components/schemas/LongInteger","example":314567896580917},"id_order":{"type":"string","example":"MB7UWLD"},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"is_marketplace_deemed_supplier":{"type":"boolean"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"status":{"$ref":"#/components/schemas/OrderUnitStatus","example":"sent"},"price":{"$ref":"#/components/schemas/Integer","example":200},"id_offer":{"type":"string","nullable":true,"example":"AB-120"},"revenue_gross":{"$ref":"#/components/schemas/Integer","example":5900},"revenue_net":{"$ref":"#/components/schemas/Integer","example":3400},"note":{"type":"string","nullable":true,"example":"Some note"},"unit_condition":{"type":"string","nullable":true,"example":"new"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"DE"},"currency":{"$ref":"#/components/schemas/Currency","example":"EUR"},"delivery_time_min":{"allOf":[{"$ref":"#/components/schemas/Integer"}],"nullable":true,"example":3},"delivery_time_max":{"allOf":[{"$ref":"#/components/schemas/Integer"}],"nullable":true,"example":6},"delivery_time_expires_iso":{"type":"string","format":"date-time","nullable":true,"example":"2021-07-28T12:13:14Z"},"order_received_timestamp_iso":{"type":"string","format":"date-time","nullable":true,"example":"2021-07-26T11:13:14Z"},"shipping_rate":{"$ref":"#/components/schemas/Integer","example":390},"cancel_reason":{"type":"string","nullable":true,"example":"BuyerCancelled"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"buyer":{"allOf":[{"$ref":"#/components/schemas/Buyer"}],"nullable":true},"billing_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"nullable":true},"product":{"allOf":[{"$ref":"#/components/schemas/Product"}],"nullable":true},"vat":{"type":"number","format":"float","nullable":true,"example":19},"eco_fee":{"type":"integer","format":"int32","nullable":true,"example":1900},"packaging_fee":{"type":"integer","format":"int32","nullable":true,"example":1950},"delivery_attempt_timestamp_iso":{"type":"string","format":"date-time","nullable":true,"description":"The attribute is only responded when explicitly requested as an embedded field","example":"2021-07-24T19:26:05Z"},"tickets":{"items":{"$ref":"#/components/schemas/Ticket"},"type":"array","nullable":true,"description":"The attribute is only responded when explicitly requested as an embedded field"},"return_unit":{"allOf":[{"$ref":"#/components/schemas/ReturnUnit"}],"nullable":true,"description":"The attribute is only responded when explicitly requested as an embedded field"},"delivery":{"$ref":"#/components/schemas/Delivery","description":"The attribute is only responded when explicitly requested as an embedded field"},"kss_eligible":{"type":"boolean","description":"The attribute is only responded when explicitly requested as an embedded field","example":true}},"required":["id_order_unit","id_order","ts_created_iso","is_marketplace_deemed_supplier","ts_updated_iso","status","price","id_offer","revenue_gross","revenue_net","note","unit_condition","storefront","currency","delivery_time_min","delivery_time_max","delivery_time_expires_iso","order_received_timestamp_iso","shipping_rate","cancel_reason","fulfillment_type","buyer","billing_address","shipping_address","product","vat"],"type":"object","additionalProperties":false},"ApiResponse_OrderUnitDetails_":{"properties":{"data":{"$ref":"#/components/schemas/OrderUnitDetails"}},"required":["data"],"type":"object","additionalProperties":false},"OrderUnitEmbeddable":{"description":"Additional data to be returned for order unit","enum":["delivery_attempt_timestamp_iso","return_unit","tickets","delivery","kss_delivery"],"type":"string"},"OrderUnitCancelReason":{"enum":["BuyerCancelled","ShippingAddressUndeliverable","WrongCatalogData","GeneralAdjustment","MerchandiseNotReceived","NoInventory","DelayedInventory","WrongPrice","NoReactionBuyer","UndeliverableRegion"],"type":"string"},"OrderUnitCancelRequest":{"properties":{"reason":{"$ref":"#/components/schemas/OrderUnitCancelReason","example":"GeneralAdjustment"}},"required":["reason"],"type":"object","additionalProperties":false},"OrderUnitSendRequest":{"properties":{"tracking_numbers":{"type":"string"},"carrier_code":{"type":"string"}},"required":["tracking_numbers","carrier_code"],"type":"object","additionalProperties":false},"OrderUnitRefundReason":{"enum":["delivery_damage","delivery_delay","incomplete_delivery","incorrect_delivery","refund_postage_fee","defect","other_refund","refund_return_postage_fee"],"type":"string"},"OrderUnitRefundRequest":{"properties":{"amount":{"$ref":"#/components/schemas/Integer"},"reason":{"$ref":"#/components/schemas/OrderUnitRefundReason"}},"required":["amount","reason"],"type":"object","additionalProperties":false},"ReturnStatus":{"enum":["return_requested","label_generated","package_sent","package_received","label_deleted"],"type":"string"},"Return":{"properties":{"id_return":{"$ref":"#/components/schemas/LongInteger","example":675849321},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"tracking_provider":{"type":"string","nullable":true,"example":"DHL"},"tracking_code":{"type":"string","nullable":true,"example":"407875042681"},"status":{"$ref":"#/components/schemas/ReturnStatus","example":"package_received"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"}},"required":["id_return","ts_created_iso","ts_updated_iso","storefront","tracking_provider","tracking_code","status","fulfillment_type"],"type":"object","additionalProperties":false},"CollectionApiResponse_Return_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Return"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ReturnDetails":{"properties":{"id_return":{"$ref":"#/components/schemas/LongInteger","example":675849321},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"tracking_provider":{"type":"string","nullable":true,"example":"DHL"},"tracking_code":{"type":"string","nullable":true,"example":"407875042681"},"status":{"$ref":"#/components/schemas/ReturnStatus","example":"package_received"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"buyer":{"allOf":[{"$ref":"#/components/schemas/Buyer"}],"nullable":true},"return_units":{"items":{"$ref":"#/components/schemas/ReturnUnit"},"type":"array"}},"required":["id_return","ts_created_iso","ts_updated_iso","storefront","tracking_provider","tracking_code","status","fulfillment_type"],"type":"object","additionalProperties":false},"ApiResponse_ReturnDetails_":{"properties":{"data":{"$ref":"#/components/schemas/ReturnDetails"}},"required":["data"],"type":"object","additionalProperties":false},"ReturnEmbeddable":{"description":"Additional data to be returned for return","enum":["buyer","return_units"],"type":"string"},"InitializeReturn":{"properties":{"id_return":{"$ref":"#/components/schemas/LongInteger","example":675849321},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"tracking_provider":{"type":"string","nullable":true,"example":"DHL"},"tracking_code":{"type":"string","nullable":true,"example":"407875042681"},"status":{"$ref":"#/components/schemas/ReturnStatus","example":"package_received"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"return_units":{"items":{"$ref":"#/components/schemas/ReturnUnit"},"type":"array"}},"required":["id_return","ts_created_iso","ts_updated_iso","storefront","tracking_provider","tracking_code","status","fulfillment_type","return_units"],"type":"object","additionalProperties":false},"ApiResponse_InitializeReturn_":{"properties":{"data":{"$ref":"#/components/schemas/InitializeReturn"}},"required":["data"],"type":"object","additionalProperties":false},"InitializeReturnRequest":{"properties":{"id_order_unit":{"$ref":"#/components/schemas/LongInteger"},"reason":{"$ref":"#/components/schemas/ReturnReason"},"note":{"type":"string"}},"required":["id_order_unit","reason","note"],"type":"object","additionalProperties":false},"UpdateReturn":{"properties":{"id_return":{"$ref":"#/components/schemas/LongInteger","example":675849321},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"ts_updated_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"tracking_provider":{"type":"string","nullable":true,"example":"DHL"},"tracking_code":{"type":"string","nullable":true,"example":"407875042681"},"status":{"$ref":"#/components/schemas/ReturnStatus","example":"package_received"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"return_units":{"items":{"$ref":"#/components/schemas/ReturnUnit"},"type":"array"}},"required":["id_return","ts_created_iso","ts_updated_iso","storefront","tracking_provider","tracking_code","status","fulfillment_type","return_units"],"type":"object","additionalProperties":false},"ApiResponse_UpdateReturn_":{"properties":{"data":{"$ref":"#/components/schemas/UpdateReturn"}},"required":["data"],"type":"object","additionalProperties":false},"UpdateReturnRequest":{"properties":{"id_order_unit":{"$ref":"#/components/schemas/LongInteger"},"reason":{"$ref":"#/components/schemas/ReturnReason"},"note":{"type":"string"}},"required":["id_order_unit","reason","note"],"type":"object","additionalProperties":false},"CollectionApiResponse_ReturnUnit_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnUnit"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ReturnUnitDetails":{"properties":{"id_return_unit":{"$ref":"#/components/schemas/LongInteger","example":7896580917},"id_return":{"$ref":"#/components/schemas/LongInteger","example":56987456},"id_order_unit":{"$ref":"#/components/schemas/LongInteger","example":314567896580917},"ts_created_iso":{"type":"string","format":"date-time","example":"2021-07-24T19:26:05Z"},"status":{"$ref":"#/components/schemas/ReturnUnitStatus","example":"return_in_repair"},"note":{"type":"string","nullable":true,"example":"This is test return"},"reason":{"$ref":"#/components/schemas/ReturnReason","example":"wrong_article"},"storefront":{"$ref":"#/components/schemas/Storefront","example":"de"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType","example":"fulfilled_by_merchant"},"return":{"$ref":"#/components/schemas/Return"},"tickets":{"items":{"$ref":"#/components/schemas/Ticket"},"type":"array","nullable":true},"order_unit":{"$ref":"#/components/schemas/OrderUnit"}},"required":["id_return_unit","id_return","id_order_unit","ts_created_iso","status","note","reason","storefront","fulfillment_type","return"],"type":"object","additionalProperties":false},"ApiResponse_ReturnUnitDetails_":{"properties":{"data":{"$ref":"#/components/schemas/ReturnUnitDetails"}},"required":["data"],"type":"object","additionalProperties":false},"ReturnUnitEmbeddable":{"description":"Additional data to be returned for return unit","enum":["return","order_unit","tickets"],"type":"string"},"ReturnUnitClarifyRequest":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object","additionalProperties":false},"ReturnUnitRejectRequest":{"properties":{"message":{"type":"string"}},"required":["message"],"type":"object","additionalProperties":false},"AddShipmentRequest":{"properties":{"id_order_unit":{"$ref":"#/components/schemas/LongInteger"},"shipment_information":{"properties":{"tracking_number":{"type":"string"},"carrier_code":{"type":"string"}},"required":["tracking_number","carrier_code"],"type":"object"}},"required":["id_order_unit","shipment_information"],"type":"object","additionalProperties":false},"SellerApiShippingGroupType":{"enum":["PACKAGE","HAULER"],"type":"string"},"SellerApiShippingGroupRegionOptionNameEnum":{"enum":["default"],"type":"string"},"ShippingGroupOption":{"properties":{"name":{"$ref":"#/components/schemas/SellerApiShippingGroupRegionOptionNameEnum"},"cost_first":{"type":"integer","format":"int32","description":"Shipping cost for the first item of this shipping group.","minimum":0},"cost_next":{"type":"integer","format":"int32","description":"Shipping cost of all further items of this shipping group.","minimum":0},"cost_max":{"type":"integer","format":"int32","description":"Maximum shipping cost","minimum":0},"cost_free":{"type":"integer","format":"int32","description":"Order value from which shipping will be free.","minimum":0},"cut_off_time":{"type":"string"},"transport_time_min":{"type":"integer","format":"int32","description":"Minimal time carrier needs from picking up the order until delivering it to the customer.","minimum":1},"transport_time_max":{"type":"integer","format":"int32","description":"Maximal time carrier needs from picking up the order until delivering it to the customer.","minimum":1}},"required":["name","cost_first","cost_next","cost_max","cost_free","cut_off_time","transport_time_min","transport_time_max"],"type":"object","additionalProperties":false},"ShippingGroupRegion":{"properties":{"countries":{"items":{"type":"string"},"type":"array","description":"List of countries in this region. Country code according to ISO 3166"},"shipping_options":{"items":{"$ref":"#/components/schemas/ShippingGroupOption"},"type":"array"}},"required":["countries","shipping_options"],"type":"object","additionalProperties":false},"ShippingGroup":{"properties":{"currency":{"$ref":"#/components/schemas/Currency"},"id_shipping_group":{"type":"integer","format":"int64","description":"ID of the shipping group","minimum":1},"storefront":{"$ref":"#/components/schemas/Storefront"},"name":{"type":"string","description":"Name of the shipping group"},"type":{"$ref":"#/components/schemas/SellerApiShippingGroupType"},"is_default":{"type":"boolean"},"regions":{"items":{"$ref":"#/components/schemas/ShippingGroupRegion"},"type":"array","description":"List of regions in this shipping group"}},"required":["currency","id_shipping_group","storefront","name","type","is_default","regions"],"type":"object","additionalProperties":false},"CollectionApiResponse_ShippingGroup_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ShippingGroup"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ApiResponse_ShippingGroup_":{"properties":{"data":{"$ref":"#/components/schemas/ShippingGroup"}},"required":["data"],"type":"object","additionalProperties":false},"UnitStatuses":{"enum":["INCOMPLETE","AVAILABLE","ONHOLD"],"type":"string"},"UnitEmbedded":{"properties":{"status":{"$ref":"#/components/schemas/UnitStatuses"},"currency":{"$ref":"#/components/schemas/Currency"},"condition":{"$ref":"#/components/schemas/UnitCondition"},"id_unit":{"type":"integer","format":"int64","description":"Internal ID of Unit, unique across all Units","minimum":1},"note":{"type":"string","nullable":true,"description":"A note for this unit"},"listing_price":{"type":"integer","format":"int32","description":"Listing price, available only for Seller","minimum":1},"minimum_price":{"type":"integer","format":"int32","description":"Minimum price, available only for Seller with Smart Pricing feature enabled","minimum":1},"price":{"type":"integer","format":"int32","description":"Price at which this unit will be offered on Kaufland.de","minimum":1},"id_offer":{"type":"string","nullable":true,"description":"Seller's unique ID for offer(s)"},"id_product":{"type":"integer","format":"int64","description":"Internal ID of Product, unique across all Products","minimum":1},"id_shipping_group":{"type":"integer","format":"int64","nullable":true,"description":"ID of the shipping group","minimum":1},"id_warehouse":{"type":"integer","format":"int64","nullable":true,"description":"ID of warehouse","minimum":1},"amount":{"type":"integer","format":"int32","description":"Amount of available Units","default":"1","minimum":0},"date_inserted_iso":{"type":"string","format":"date-time","description":"DateTime when unit was created"},"date_lastchange_iso":{"type":"string","format":"date-time","description":"DateTime when unit has been edited for the last time"},"handling_time":{"type":"integer","format":"int32","description":"handling time","minimum":0,"maximum":100},"shipping_rate":{"type":"integer","format":"int32","minimum":0},"storefront":{"$ref":"#/components/schemas/Storefront"},"transport_time_min":{"type":"integer","format":"int32","description":"Transport time minimum","minimum":1},"transport_time_max":{"type":"integer","format":"int32","description":"Transport time maximum","minimum":1},"product":{"$ref":"#/components/schemas/Product"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType"},"vat_indicator":{"$ref":"#/components/schemas/VatIndicator"},"eco_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Eco-Participation value in eurocents (integer). Only relevant for specific products on the French storefront.","minimum":1},"battery_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Battery-Participation value in eurocents (integer).","minimum":1}},"required":["status","currency","condition","id_unit","note","listing_price","minimum_price","price","id_offer","id_product","id_shipping_group","id_warehouse","amount","date_inserted_iso","date_lastchange_iso","handling_time","shipping_rate","storefront","transport_time_min","transport_time_max","fulfillment_type","vat_indicator"],"type":"object","additionalProperties":false},"CollectionApiResponse_UnitEmbedded_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/UnitEmbedded"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"UnitAndProductEmbeddedEnum":{"enum":["products","eco_participation","battery_participation",""],"type":"string"},"Unit":{"properties":{"status":{"$ref":"#/components/schemas/UnitStatuses"},"currency":{"$ref":"#/components/schemas/Currency"},"id_unit":{"type":"integer","format":"int64","minimum":1},"note":{"type":"string","nullable":true,"description":"A note for this unit","maxLength":250},"condition":{"$ref":"#/components/schemas/UnitCondition"},"listing_price":{"type":"integer","format":"int32","minimum":1},"minimum_price":{"type":"integer","format":"int32","minimum":1},"price":{"type":"integer","format":"int32","description":"Price at which this unit will be offered on Kaufland.de","minimum":1},"id_offer":{"type":"string","nullable":true,"description":"Seller's unique ID for offer(s)"},"id_product":{"type":"integer","format":"int64","minimum":1},"id_shipping_group":{"type":"integer","format":"int32","nullable":true,"minimum":1},"id_warehouse":{"type":"integer","format":"int32","nullable":true,"minimum":1},"amount":{"type":"integer","format":"int32","default":"1","minimum":0},"date_inserted_iso":{"type":"string","format":"date-time"},"date_lastchange_iso":{"type":"string","format":"date-time"},"handling_time":{"type":"integer","format":"int32","minimum":0},"shipping_rate":{"type":"integer","format":"int32","minimum":0},"storefront":{"$ref":"#/components/schemas/Storefront"},"transport_time_min":{"type":"integer","format":"int32","minimum":1},"transport_time_max":{"type":"integer","format":"int32","minimum":1},"product":{"$ref":"#/components/schemas/Product"},"fulfillment_type":{"$ref":"#/components/schemas/FulfillmentType"},"vat_indicator":{"$ref":"#/components/schemas/VatIndicator"},"eco_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Eco-Participation value in eurocents (integer). Only relevant for specific products on the French storefront.","minimum":1},"battery_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Battery-Participation value in eurocents (integer).","minimum":1}},"required":["status","currency","id_unit","note","condition","listing_price","minimum_price","price","id_offer","id_product","id_shipping_group","id_warehouse","amount","date_inserted_iso","date_lastchange_iso","handling_time","shipping_rate","storefront","transport_time_min","transport_time_max","fulfillment_type","vat_indicator"],"type":"object","additionalProperties":false},"ApiResponse_Unit_":{"properties":{"data":{"$ref":"#/components/schemas/Unit"}},"required":["data"],"type":"object","additionalProperties":false},"WriteableVatIndicator":{"enum":["standard_rate","reduced_rate_1","reduced_rate_2","super_reduced_rate","zero_rate"],"type":"string"},"UnitRequest":{"properties":{"amount":{"type":"integer","format":"int32","description":"Amount of available Units","default":"1","minimum":0},"handling_time":{"type":"integer","format":"int32","description":"handling time","minimum":0,"maximum":100},"listing_price":{"type":"integer","format":"int32","description":"Listing price, in integral cents of the storefront's currency (CZK for cz, EUR for de, sk, at, fr, it and PLN for pl). Minimum 1 cent, maximum differs by storefront (25 million CZK, 1 million EUR or 4.5 million PLN).","minimum":1},"minimum_price":{"type":"integer","format":"int32","description":"Minimum price, in integral cents of the storefront's currency. Only relevant if you want to use Smart Pricing.","minimum":1},"note":{"type":"string","description":"A note for this unit","maxLength":250},"id_shipping_group":{"type":"integer","format":"int64","description":"ID of the shipping group"},"id_warehouse":{"type":"integer","format":"int64","description":"ID of warehouse"},"ean":{"type":"string","description":"EAN, 13 or 14 digits"},"id_product":{"type":"integer","format":"int64","description":"Internal ID of Product, unique across all Products"},"id_offer":{"type":"string","description":"Seller's unique ID for offer(s)"},"condition":{"anyOf":[{"type":"integer","format":"int32"},{"$ref":"#/components/schemas/UnitCondition"}],"description":"Unit's condition.","default":"NEW"},"vat_indicator":{"$ref":"#/components/schemas/WriteableVatIndicator"},"eco_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Eco-Participation value in eurocents (integer). Only relevant for specific products on the French storefront.","minimum":1},"battery_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Battery-Participation value in eurocents (integer).","minimum":1}},"required":["handling_time","listing_price","id_offer"],"type":"object","additionalProperties":false},"UnitEmbeddedEnum":{"enum":["eco_participation","battery_participation",""],"type":"string"},"WriteableUnitStatuses":{"enum":["AVAILABLE","ONHOLD"],"type":"string"},"UnitPatchRequest":{"properties":{"status":{"$ref":"#/components/schemas/WriteableUnitStatuses"},"amount":{"type":"integer","format":"int32","description":"Amount of available Units","minimum":0},"handling_time":{"type":"integer","format":"int32","description":"handling time","minimum":0,"maximum":100},"listing_price":{"type":"integer","format":"int32","description":"Listing price, in integral cents of the storefront's currency (CZK for cz, EUR for de, sk, at, fr, it and PLN for pl). Minimum 1 cent, maximum differs by storefront (25 million CZK, 1 million EUR or 4.5 million PLN).","minimum":1},"minimum_price":{"type":"integer","format":"int32","description":"Minimum price, in integral cents of the storefront's currency. Only relevant if you want to use Smart Pricing.","minimum":1},"note":{"type":"string","description":"A note for this unit"},"id_shipping_group":{"type":"integer","format":"int64","description":"ID of the shipping group"},"id_warehouse":{"type":"integer","format":"int64","description":"ID of warehouse"},"vat_indicator":{"$ref":"#/components/schemas/WriteableVatIndicator"},"eco_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Eco-Participation value in eurocents (integer). Only relevant for specific products on the French storefront.","minimum":1},"battery_participation":{"type":"integer","format":"int32","nullable":true,"description":"The Battery-Participation value in eurocents (integer).","minimum":1}},"type":"object","additionalProperties":false},"UnitsBulkUpdatedUnit":{"properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"status_code":{"type":"number","format":"double","minimum":200},"unit":{"$ref":"#/components/schemas/Unit"}},"required":["id_unit","status_code","unit"],"type":"object","additionalProperties":false},"UnitsBulkUpdateErrorDetail":{"properties":{"field":{"type":"string"},"message":{"type":"string"}},"required":["field","message"],"type":"object","additionalProperties":false},"UnitsBulkUpdateErrorDetails":{"properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"status_code":{"type":"integer","format":"int32","minimum":200},"message":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/UnitsBulkUpdateErrorDetail"},"type":"array"}},"required":["id_unit","status_code","message","errors"],"type":"object","additionalProperties":false},"UnitsBulkUpdateInternalError":{"properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"status_code":{"type":"number","format":"double","minimum":200},"key":{"type":"string"},"message":{"type":"string"}},"required":["id_unit","status_code","key","message"],"type":"object","additionalProperties":false},"UnitsBulkUpdateResponse":{"properties":{"data":{"items":{"anyOf":[{"$ref":"#/components/schemas/UnitsBulkUpdatedUnit"},{"$ref":"#/components/schemas/UnitsBulkUpdateErrorDetails"},{"$ref":"#/components/schemas/UnitsBulkUpdateInternalError"}]},"type":"array"}},"required":["data"],"type":"object","additionalProperties":false,"example":{"data":[{"id_unit":1000,"status_code":400,"message":"Parameters [listingPrice] are missing or have wrong value.","errors":[{"field":"listing_price","message":"listing_price must be greater than 0"}]},{"id_unit":1,"status_code":200,"unit":{"id_unit":1,"status":"AVAILABLE","currency":"EUR","condition":"NEW","note":null,"id_warehouse":null,"id_shipping_group":null,"id_offer":null,"listing_price":100,"minimum_price":100,"price":100,"id_product":1,"amount":1,"date_inserted_iso":"2023-11-30T00:00:00.000Z","date_lastchange_iso":"2023-11-30T00:00:00.000Z","handling_time":1,"shipping_rate":1,"storefront":"DE","transport_time_min":1,"transport_time_max":1,"fulfillment_type":"fulfilled_by_merchant"}}]}},"UnitsBulkUpdateRequest":{"properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"unit_data":{"$ref":"#/components/schemas/UnitPatchRequest"}},"required":["id_unit","unit_data"],"type":"object","additionalProperties":false},"WarehouseAddress":{"properties":{"street":{"type":"string","description":"Street part of Warehouse's address."},"city":{"type":"string","description":"City part of Warehouse's address."},"house_number":{"type":"string","description":"House number part of Warehouse's address."},"postcode":{"type":"string","description":"Postal code of Warehouse's address."},"country":{"type":"string","description":"Country code according to ISO 3166"},"phone":{"type":"string","nullable":true,"description":"Phone number of Warehouse."}},"required":["street","city","house_number","postcode","country","phone"],"type":"object","additionalProperties":false},"SellerApiWarehouseType":{"enum":["normal","dropshipment"],"type":"string"},"Warehouse":{"properties":{"id_warehouse":{"type":"integer","format":"int64","description":"Internal ID of Warehouse, unique across all Warehouses","minimum":1},"name":{"type":"string","description":"Name of warehouse"},"address":{"$ref":"#/components/schemas/WarehouseAddress"},"is_default":{"type":"boolean","description":"Is this Warehouse set as default for you."},"type":{"$ref":"#/components/schemas/SellerApiWarehouseType"}},"required":["id_warehouse","name","address","is_default","type"],"type":"object","additionalProperties":false},"CollectionApiResponse_Warehouse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Warehouse"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ApiResponse_Warehouse_":{"properties":{"data":{"$ref":"#/components/schemas/Warehouse"}},"required":["data"],"type":"object","additionalProperties":false},"WarehouseAddressRequest":{"properties":{"street":{"type":"string","description":"Street part of Warehouse's address."},"city":{"type":"string","description":"City part of Warehouse's address."},"house_number":{"type":"string","description":"House number part of Warehouse's address."},"postcode":{"type":"string","description":"Postal code of Warehouse's address."},"country":{"type":"string","description":"Country code according to ISO 3166"},"phone":{"type":"string","description":"Phone number of Warehouse."}},"required":["street","city","house_number","postcode","country"],"type":"object","additionalProperties":false},"WarehouseBodyRequest":{"properties":{"name":{"type":"string","description":"Name of warehouse"},"address":{"$ref":"#/components/schemas/WarehouseAddressRequest"},"is_default":{"type":"boolean","description":"Is this Warehouse set as default for you."}},"required":["name","address","is_default"],"type":"object","additionalProperties":false},"PingMessage":{"properties":{"message":{"type":"string","example":"Never tell me the odds"}},"required":["message"],"type":"object","additionalProperties":false},"ApiResponse_PingMessage_":{"properties":{"data":{"$ref":"#/components/schemas/PingMessage"}},"required":["data"],"type":"object","additionalProperties":false},"SubscriptionEventName":{"enum":["order_new","order_unit_new","order_unit_status_changed","item_changed","category_changed","return_new","return_status_changed","return_unit_status_changed","item_unit_new","item_unit_changed","item_unit_deleted","item_unit_out_of_stock","item_unit_not_available","item_unit_available"],"type":"string"},"Subscription":{"properties":{"id_subscription":{"type":"number","format":"double","example":11011},"callback_url":{"type":"string","example":"https://www.kaufland.de"},"fallback_email":{"type":"string","example":"test@kaufland.de"},"event_name":{"$ref":"#/components/schemas/SubscriptionEventName","example":"order_new"},"is_active":{"type":"boolean","example":true},"storefront":{"type":"string","nullable":true,"example":"de"}},"required":["id_subscription","callback_url","fallback_email","event_name","is_active","storefront"],"type":"object","additionalProperties":false},"CollectionApiResponse_Subscription_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"ApiResponse_Subscription_":{"properties":{"data":{"$ref":"#/components/schemas/Subscription"}},"required":["data"],"type":"object","additionalProperties":false},"Pick_Subscription.callback_url-or-fallback_email-or-event_name_":{"properties":{"callback_url":{"type":"string","example":"https://www.kaufland.de"},"fallback_email":{"type":"string","example":"test@kaufland.de"},"event_name":{"$ref":"#/components/schemas/SubscriptionEventName","example":"order_new"}},"required":["callback_url","fallback_email","event_name"],"type":"object","description":"From T, pick a set of properties whose keys are in the union K"},"CreateSubscriptionRequest":{"$ref":"#/components/schemas/Pick_Subscription.callback_url-or-fallback_email-or-event_name_"},"Partial_Pick_Subscription.callback_url-or-fallback_email-or-event_name-or-is_active-or-storefront__":{"properties":{"callback_url":{"type":"string","example":"https://www.kaufland.de"},"fallback_email":{"type":"string","example":"test@kaufland.de"},"event_name":{"$ref":"#/components/schemas/SubscriptionEventName","example":"order_new"},"is_active":{"type":"boolean","example":true},"storefront":{"type":"string","nullable":true,"example":"de"}},"type":"object","description":"Make all properties in T optional"},"UpdateSubscriptionRequest":{"$ref":"#/components/schemas/Partial_Pick_Subscription.callback_url-or-fallback_email-or-event_name-or-is_active-or-storefront__"}},"securitySchemes":{}},"info":{"title":"Kaufland.de Seller API v2","version":"2.27.2","description":"This is the Kaufland.de Seller API v2. You can find more information on [https://sellerapi.kaufland.com/](https://sellerapi.kaufland.com/)","contact":{"name":"Kaufland.de Seller API Support ","email":"seller-api-support@kaufland-online.de"}},"openapi":"3.0.0","paths":{"/assortment-coverage/insights":{"get":{"operationId":"GetAssortmentInsight","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_AssortmentInsight_"},"examples":{"Example 1":{"value":{"data":[{"ean":"04062784153675","item_name":"Joe Nimble Trail Addict WR","brand":"Joe Nimble","category":"Fashion & accessories","category_2":"Shoes & accessories","buybox_price_l_90_day":1716,"buybox_price_l_60_day":1724,"buybox_price_l_30_day":1696,"buybox_price_current":1556,"sales_rank":61217,"external_rank":12815,"external_demand_indicator":"Low","benchmark_price_min":1500,"benchmark_price_max":1800,"external_bestseller_missed":false,"popular_product_bad_priced":false,"kaufland_bestseller":false,"currency":"EUR"},{"ean":"04067896931531","item_name":"HJC Helm C10 Epik","brand":null,"category":"Auto & Motorrad","category_2":null,"buybox_price_l_90_day":null,"buybox_price_l_60_day":null,"buybox_price_l_30_day":null,"buybox_price_current":null,"sales_rank":null,"external_rank":6291,"external_demand_indicator":"Very low","benchmark_price_min":null,"benchmark_price_max":null,"external_bestseller_missed":false,"popular_product_bad_priced":false,"kaufland_bestseller":false,"currency":"EUR"}],"pagination":{"offset":0,"limit":10,"total":2}}}}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Assortment Insights"],"security":[],"parameters":[{"description":"Offset applied to result set","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}},{"description":"Desired size of result set","in":"query","name":"limit","required":false,"schema":{"default":10,"format":"int32","type":"integer","maximum":5000,"minimum":1}}]}},"/shipping-labels":{"post":{"operationId":"CreateShippingLabel","responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_CreateShippingLabelResponse_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"You can read about Kaufland Shipment Solutions (KSS) <a href=\"/?page=kss\" target=\"_blank\">here</a>.\n\nThis endpoint provides a temporary link to a PDF file that contains the shipping label.\n\nPlease consider shipping restrictions that apply.\n\n`ids_order_units` is a list of order unit IDs that are to be shipped in the same package.\n\n`carriers` is a list of carriers you are able to use to ship the package. If you want to use a specific carrier, you can pass only the desired carrier.\nThe carrier must be one of the following: `GLS`\n\n`package_measurements` are the properties of the package. The `weight` is in grams, the `width`, `height`, and `length` are in centimeters.\n\nIf the response is successful, the response will contain the following properties:\n- `id` is the ID of the shipment label.\n- `tracking_number` is the tracking number of the shipment.\n- `carrier` is the carrier used to ship the package.\n- `download_url` is the URL to download the shipping label, the download url works for 7 days.\n\nIf you are using the playground environment, the response will always return a dummy success response.","summary":"Request and create a shipping label.","tags":["Shipping Labels"],"security":[],"parameters":[],"requestBody":{"description":"Request body containing information about the specification of the shipment.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateShippingLabelRequest","description":"Request body containing information about the specification of the shipment."},"example":{"ids_order_units":[123456789,987654321],"carriers":["GLS"],"package_measurements":{"weight_gram":1500,"width_cm":10,"height_cm":20,"length_cm":30}}}}}}},"/info/vat-indicators":{"get":{"operationId":"GetVatIndicators","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_CountryVatRates-Array_"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"This endpoint provides a mapping between vat_indicators and actually used vat rates per storefront. The response yields which vat_indicators is accepted on a given storefront.\nThe vat_indicators can (optionally) be used when creating/updating offers.","summary":"Get a list of Vat Indicators Mappings per Storefront","tags":["Info"],"security":[],"parameters":[{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}}]}},"/playground/orders":{"post":{"operationId":"CreatePlaygroundOrder","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseCollectionApiResponse_createdOrder_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Create a playground order.\n\nTHIS ENDPOINT IS ONLY EXPOSED ON THE PLAYGROUND ENVIRONMENT.","summary":"Creates a dummy order on the kaufland playground API environment.","tags":["Playground","Orders"],"security":[],"parameters":[{"description":"Locale of storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createCollectionInput_UnitsDetails_"}}}}}},"/buybox":{"get":{"operationId":"getOffersRankings","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_OffersRankings_"},"examples":{"Example 1":{"value":{"data":{"id_product":8475634,"storefront":"cz","condition":"new","num_units":1,"units":[{"buybox_rank":1,"seller":"Kaufland Seller","price":1999,"delivery_time_max":4,"delivery_time_min":3,"shipping_rate":700,"fulfillment_type":"fulfilled_by_merchant","id_unit":28374940,"id_offer":"SKU1342"}]}}}}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"This endpoint retrieves the top-ranked offers for a specified product, with an optional limit parameter to\nspecify the maximum number of offers (up to 10).","summary":"Get a list of offers rankings for a product","tags":["Buybox"],"security":[],"parameters":[{"description":"Our internal id_product","in":"query","name":"id_product","required":true,"schema":{"format":"int64","type":"integer","minimum":1}},{"description":"Desired size of offsets set, maximum is 10","in":"query","name":"limit","required":false,"schema":{"default":10,"format":"int32","type":"integer","maximum":10,"minimum":1}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"The condition of the offers","in":"query","name":"condition","required":true,"schema":{"$ref":"#/components/schemas/BuyboxCondition"}}]}},"/variant-suggestions/feed":{"get":{"operationId":"GetVariantSuggestionsFeedList","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_ProductCategoriesImportFileResponse_"},"examples":{"Example 1":{"value":{"data":[{"id_import_file":123,"uri":"https://upload.wikimedia.org/wikipedia/commons/4/44/Kaufland_201x_logo.svg","status":"ABORTED","note":"Import aborted, no changes (2021-05-31 01:24:09)","total_lines":123,"current_line":123,"ts_created":"2021-05-31 01:06:05","ts_updated":"2021-05-31 01:06:05","ts_last_row_updated":null,"ts_completed":null,"error_count":0,"async_import_done":0}],"pagination":{"total":1,"limit":20,"offset":0}}}}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of all your import files. You can narrow down the search using various parameters.","summary":"Get import files","tags":["Variant Suggestion"],"security":[],"parameters":[{"description":"The status of your import","in":"query","name":"status","required":false,"schema":{"$ref":"#/components/schemas/ProductCategoriesImportFileStatus"}},{"description":"Creation timestamp of the import file in ISO 8601","in":"query","name":"ts_created","required":false,"schema":{"format":"date","type":"string"}},{"description":"Update timestamp of the import file in ISO 8601","in":"query","name":"ts_updated","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Select the field (time created or time updated) and the direction of sorting (ascending or descending)","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/ProductCategoriesImportFileSorting"}},{"description":"Desired size of result set. Max: 100","in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer","minimum":0,"maximum":100}},{"description":"Offset applied to result set","in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer","minimum":0}}]}},"/variant-suggestions/feed/{id_import_file}":{"get":{"operationId":"GetVariantSuggestionsFeed","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ProductCategoriesImportFileResponse_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Import file not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get an import file by its ID.","summary":"Get import file by ID","tags":["Variant Suggestion"],"security":[],"parameters":[{"in":"path","name":"id_import_file","required":true,"schema":{"format":"int64","type":"integer","minimum":1}}]}},"/variant-suggestions/feed/upload-by-url":{"post":{"operationId":"UploadVariantSuggestionFileByUrl","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ProductCategoriesImportFileResponse_"},"examples":{"Example 1":{"value":{"data":{"id_import_file":123,"uri":"https://upload.wikimedia.org/wikipedia/commons/4/44/Kaufland_201x_logo.svg","status":"ABORTED","note":"Import aborted, no changes (2021-05-31 01:24:09)","total_lines":123,"current_line":123,"ts_created":"2021-05-31 01:06:05","ts_updated":"2021-05-31 01:06:05","ts_last_row_updated":null,"ts_completed":null,"error_count":0,"async_import_done":0}}}}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests Error Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Saves an URL where a new import file is located.\nThe file located at the URL will be downloaded and processed asynchronously and the contents imported.\nFor the upload of product feed data there is a limit of 30 feeds per day, so please combine data for multiple products in one CSV file if possible.","summary":"Add an import file URL","tags":["Variant Suggestion"],"security":[],"parameters":[],"requestBody":{"description":"Json object with import file data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCategoriesImportFileRequestBody","description":"Json object with import file data"},"example":{"url":"http://www.example.com/my_products.csv"}}}}}},"/info/locale":{"get":{"operationId":"GetAllLocales","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_InfoLocaleObject_"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get all available values for the parameter 'locale'. This parameter specifies the language of e.g. product data.","summary":"Get values for parameter 'locale'","tags":["Info"],"security":[],"parameters":[]}},"/info/storefront":{"get":{"operationId":"GetAllStorefronts","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_string-Array_"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get current seller available values for the parameter 'storefront'. This parameter specifies the country of the store.\nReturns a list of storefronts the seller has created in the sellerportal regardless of storefront status.","summary":"Get values for parameter 'storefront'","tags":["Info"],"security":[],"parameters":[]}},"/products/ean/{ean}":{"get":{"operationId":"GetProductByEan","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ProductWithEmbedded_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a product by EAN","summary":"Get a product by EAN","tags":["Products"],"security":[],"parameters":[{"description":"European Article Number with 13, 14 or 15 digits","in":"path","name":"ean","required":true,"schema":{"type":"string"},"example":4010884503135},{"description":"Specifies the store by country","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Include related entities in the result (if both parameters \"category\" and \"category_basics\" are provided, only the parameter \"category\" is used)","in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductEmbeddable"}}}]}},"/orders":{"get":{"operationId":"GetOrders","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_Order_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of orders.","summary":"Get a list of orders","tags":["Orders"],"security":[],"parameters":[{"description":"Locale of storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Get only orders which were\nplaced after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_created_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Get only orders which units were\nupdated after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_units_updated_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Get only orders which are fulfilled by the given type. <br/> The value `fulfilled_by_kaufland` is **DEPRECATED**.","in":"query","name":"fulfillment_type","required":false,"schema":{"default":["fulfilled_by_merchant"],"type":"array","items":{"$ref":"#/components/schemas/FulfillmentType"}},"example":"[fulfilled_by_merchant]"},{"description":"Desired size of result set<br>max: 100, default: 30","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":100,"minimum":1}},{"description":"Offset applied to result set<br>default: 0","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}}]}},"/orders/{id_order}":{"get":{"operationId":"GetOrder","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_OrderDetails_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get an order by <code>id_order</code>.","summary":"Get an order by ID","tags":["Orders"],"security":[],"parameters":[{"description":"Order ID, unique across all orders","in":"path","name":"id_order","required":true,"schema":{"type":"string"},"example":"MB7UWLD"},{"description":"Add 'order_invoices' to get order related invoices in the response.","in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderEmbeddable"}}}]}},"/order-units":{"get":{"operationId":"GetOrderUnits","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_OrderUnit_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of order units.","summary":"Get a list of order units","tags":["Order Units"],"security":[],"parameters":[{"description":"Locale of storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Unique ID for offer(s)","in":"query","name":"id_offer","required":false,"schema":{"type":"string"}},{"description":"Get only order units which are in the given status","in":"query","name":"status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderUnitStatus"}},"example":"need_to_be_sent"},{"description":"Get only order units which were\nplaced after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_created_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Get only order units which were\nupdated after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_updated_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Get only order units which are fulfilled by the given type. <br/> The value `fulfilled_by_kaufland` is **DEPRECATED**.","in":"query","name":"fulfillment_type","required":false,"schema":{"default":["fulfilled_by_merchant"],"type":"array","items":{"$ref":"#/components/schemas/FulfillmentType"}},"example":"[fulfilled_by_merchant]"},{"description":"Specify sorting","in":"query","name":"sort","required":false,"schema":{"default":"ts_created:desc","type":"string","enum":["ts_created:desc","ts_updated:desc"]},"example":"ts_created:desc"},{"description":"Desired size of result set<br>max: 100, default: 30","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":100,"minimum":1}},{"description":"Offset applied to result set<br>default: 0","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}}]}},"/order-units/{id_order_unit}":{"get":{"operationId":"GetOrderUnit","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_OrderUnitDetails_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get an order unit by <code>id_order_unit</code>.","summary":"Get an order unit by ID","tags":["Order Units"],"security":[],"parameters":[{"description":"Order unit ID, unique across all order units","in":"path","name":"id_order_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":314567898654242},{"description":"Additional data to be returned","in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderUnitEmbeddable"}}}]}},"/order-units/{id_order_unit}/cancel":{"patch":{"operationId":"CancelOrderUnit","responses":{"204":{"description":"Order unit cancelled successfully"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Cancel an order unit. Valid values for `reason` can be found in the\n<a href=\"https://sellerapi.kaufland.com/?page=order-files#cancellation-reasons\" target=\"_blank\">documentation</a>.","summary":"Cancel an order unit","tags":["Order Units"],"security":[],"parameters":[{"description":"Order unit ID, unique across all order units","in":"path","name":"id_order_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":314567898654242}],"requestBody":{"description":"Reason of the cancellation","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUnitCancelRequest","description":"Reason of the cancellation"}}}}}},"/order-units/{id_order_unit}/send":{"patch":{"operationId":"SendOrderUnit","responses":{"204":{"description":"Order unit successfully marked as sent"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Mark an order unit as sent. Valid values for `carrier_code` can be found in the\n<a href=\"https://sellerapi.kaufland.com/?page=order-files#carrier-codes\" target=\"_blank\">documentation</a>.","summary":"Mark an order unit as sent","tags":["Order Units"],"security":[],"parameters":[{"description":"Order unit ID, unique across all order units","in":"path","name":"id_order_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":314567898654242}],"requestBody":{"description":"Request body containing tracking number(s) and carrier code of the shipment(s)","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUnitSendRequest","description":"Request body containing tracking number(s) and carrier code of the shipment(s)"},"example":{"tracking_numbers":"0034123456789,0034987654321","carrier_code":"DHL"}}}}}},"/order-units/{id_order_unit}/refund":{"patch":{"operationId":"RefundOrderUnit","responses":{"204":{"description":"Refund successfully created"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Send a refund to a customer for a particular order unit.<br>`amount` must be in Eurocents.<br>\nAllowed values for `reason` can be found in the\n<a href=\"https://sellerapi.kaufland.com/?page=orders#refunding-order-unit\" target=\"_blank\">documentation</a>.","summary":"Send a refund to a customer","tags":["Order Units"],"security":[],"parameters":[{"description":"Order unit ID, unique across all order units","in":"path","name":"id_order_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":314567898654242}],"requestBody":{"description":"Request body containing amount and reason of the refund.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUnitRefundRequest","description":"Request body containing amount and reason of the refund."},"example":{"amount":1299,"reason":"delivery_delay"}}}}}},"/order-units/{id_order_unit}/fulfil":{"patch":{"operationId":"FulfilOrderUnit","responses":{"204":{"description":"Order unit status successfully changed"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Mark an order unit to be in fulfillment (It will update the order unit status to `need_to_be_sent`).","summary":"Mark an order unit to be in fulfillment","tags":["Order Units"],"security":[],"parameters":[{"description":"Order unit ID, unique across all order units","in":"path","name":"id_order_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":314567898654242}]}},"/returns":{"get":{"operationId":"GetReturns","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_Return_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of returns.","summary":"Get a list of returns","tags":["Returns"],"security":[],"parameters":[{"description":"Locale of storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Get only returns which were\nplaced after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_created_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Get only returns which were\nupdated after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_updated_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"The tracking code of a particular return","in":"query","name":"tracking_code","required":false,"schema":{"type":"string"},"example":"0034123456789"},{"description":"Get only returns which are in the given status","in":"query","name":"status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReturnStatus"}},"example":"[package_received]"},{"description":"Get only returns which are fulfilled by the given type. <br/> The value `fulfilled_by_kaufland` is **DEPRECATED**.","in":"query","name":"fulfillment_type","required":false,"schema":{"default":["fulfilled_by_merchant"],"type":"array","items":{"$ref":"#/components/schemas/FulfillmentType"}},"example":"[fulfilled_by_merchant]"},{"description":"Specify sorting","in":"query","name":"sort","required":false,"schema":{"default":"ts_created:desc","type":"string","enum":["ts_created:desc","ts_updated:desc"]},"example":"ts_created:desc"},{"description":"Desired size of result set<br>max: 100, default: 30","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":100,"minimum":1}},{"description":"Offset applied to result set<br>default: 0","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}}]},"post":{"operationId":"InitiateReturn","responses":{"201":{"description":"Return successfully initialized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_InitializeReturn_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Initialize a return for one or more order units. All order units must belong to the same order.<br>\nValid values for `reason` can be found in the\n<a href=\"https://sellerapi.kaufland.com/?page=returns\" target=\"_blank\">documentation</a>.<br>\n`note` must be at least 5 and maximal 100 characters long.","summary":"Initialize a return","tags":["Returns"],"security":[],"parameters":[],"requestBody":{"description":"Request body containing return data for one or more order units","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InitializeReturnRequest"},"type":"array","description":"Request body containing return data for one or more order units"},"example":[{"id_order_unit":314567898654242,"reason":"wrong_size","note":"A note"}]}}}}},"/returns/{id_return}":{"get":{"operationId":"GetReturn","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ReturnDetails_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a return by <code>id_return</code>.","summary":"Get a return by ID","tags":["Returns"],"security":[],"parameters":[{"description":"Return ID, unique across all returns","in":"path","name":"id_return","required":true,"schema":{"format":"int64","type":"integer"},"example":675849321},{"description":"Additional data to be returned","in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReturnEmbeddable"}}}]},"put":{"operationId":"UpdateReturn","responses":{"201":{"description":"Return updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_UpdateReturn_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Add one or more order units to an already existing return. All order units must belong to the same order.","summary":"Add one or more order units to an already existing return","tags":["Returns"],"security":[],"parameters":[{"description":"Return ID, unique across all returns","in":"path","name":"id_return","required":true,"schema":{"type":"string"},"example":675849321}],"requestBody":{"description":"Request body containing return data for one or more order units","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UpdateReturnRequest"},"type":"array","description":"Request body containing return data for one or more order units"},"example":[{"id_order_unit":314567898654242,"reason":"wrong_size","note":"A note"}]}}}}},"/return-units":{"get":{"operationId":"GetReturnUnits","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_ReturnUnit_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of return units.","summary":"Get a list of return units","tags":["Return Units"],"security":[],"parameters":[{"description":"Locale of storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Get only return units which were\nplaced after this timestamp. Should be in YYYY-MM-ddTHH:mm:ssZ format","in":"query","name":"ts_created_from_iso","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Get only return units which are in the given status","in":"query","name":"status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReturnUnitStatus"}},"example":"[return_arrived]"},{"description":"Get only return units which are fulfilled by the given type.<br/> The value `fulfilled_by_kaufland` is **DEPRECATED**.","in":"query","name":"fulfillment_type","required":false,"schema":{"default":["fulfilled_by_merchant"],"type":"array","items":{"$ref":"#/components/schemas/FulfillmentType"}},"example":"[fulfilled_by_merchant]"},{"description":"Specify sorting","in":"query","name":"sort","required":false,"schema":{"default":"ts_created:desc","type":"string","enum":["ts_created:desc","ts_updated:desc"]},"example":"ts_created:desc"},{"description":"Desired size of result set<br>max: 100, default: 30","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Integer"}},{"description":"Offset applied to result set<br>default: 0","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Integer"}}]}},"/return-units/{id_return_unit}":{"get":{"operationId":"GetReturnUnit","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ReturnUnitDetails_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a return unit by <code>id_return_unit</code>.","summary":"Get a return unit by ID","tags":["Return Units"],"security":[],"parameters":[{"description":"Return unit ID, unique across all return units","in":"path","name":"id_return_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":7896580917},{"description":"Additional data to be returned","in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReturnUnitEmbeddable"}}}]}},"/return-units/{id_return_unit}/accept":{"patch":{"operationId":"AcceptReturnUnit","responses":{"204":{"description":"Return unit accepted successfully"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Mark a return unit as `return_accepted`.","summary":"Accept a return unit","tags":["Return Units"],"security":[],"parameters":[{"description":"Return unit ID, unique across all return units","in":"path","name":"id_return_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":7896580917}]}},"/return-units/{id_return_unit}/clarify":{"patch":{"operationId":"ClarifyReturnUnit","responses":{"204":{"description":"Return unit set to clarification status successfully"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Mark a return unit as `return_in_clarification` to indicate a problem with a return unit after it has been received.\nWill open a ticket addressing the customer with the given message.","summary":"Clarify a return unit","tags":["Return Units"],"security":[],"parameters":[{"description":"Return unit ID, unique across all return units","in":"path","name":"id_return_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":7896580917}],"requestBody":{"description":"Request body containing message for clarifying return unit","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnUnitClarifyRequest","description":"Request body containing message for clarifying return unit"},"example":{"message":"needs clarification"}}}}}},"/return-units/{id_return_unit}/reject":{"patch":{"operationId":"RejectReturnUnit","responses":{"204":{"description":"Return unit rejected successfully"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Mark a return unit as `return_rejected`. Will open a ticket addressing the customer with the given message.","summary":"Reject a return unit","tags":["Return Units"],"security":[],"parameters":[{"description":"Return unit ID, unique across all return units","in":"path","name":"id_return_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":7896580917}],"requestBody":{"description":"Request body containing message for rejecting return unit","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnUnitRejectRequest","description":"Request body containing message for rejecting return unit"},"example":{"message":"Can not be returned"}}}}}},"/return-units/{id_return_unit}/repair":{"patch":{"operationId":"RepairReturnUnit","responses":{"204":{"description":"Return unit set to repair status successfully"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Mark a return unit as `return_in_repair`.","summary":"Repair a return unit","tags":["Return Units"],"security":[],"parameters":[{"description":"Return unit ID, unique across all return units","in":"path","name":"id_return_unit","required":true,"schema":{"format":"int64","type":"integer"},"example":7896580917}]}},"/shipments":{"post":{"operationId":"AddShipment","responses":{"204":{"description":"Shipment successfully added"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Add a shipment to an order unit which is already marked as sent by providing a carrier code and a tracking number.<br>\nValid values for `carrier_code` can be found in the\n<a href=\"https://sellerapi.kaufland.com/?page=order-files#carrier-codes\" target=\"_blank\">documentation</a>.","summary":"Add a shipment to an order unit which is already marked as sent.","tags":["Shipments"],"security":[],"parameters":[],"requestBody":{"description":"Request body containing information about a shipment related to an order unit","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddShipmentRequest","description":"Request body containing information about a shipment related to an order unit"},"example":{"id_order_unit":"123456789","shipment_information":{"carrier_code":"DHL","tracking_number":"0034987654321"}}}}}}},"/shipping-groups":{"get":{"operationId":"getShippingGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_ShippingGroup_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get the list of your predefined shipping groups.","summary":"Get the list of your predefined shipping groups","tags":["Shipping Groups"],"security":[],"parameters":[{"description":"Desired size of result set","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":30,"minimum":0}},{"description":"Offset applied to result set","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}}]}},"/shipping-groups/{id_shipping_group}":{"get":{"operationId":"getShippingGroup","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ShippingGroup_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Shipping-Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a shipping group by <code>id_shipping_group</code>.","summary":"Get a shipping group by ID","tags":["Shipping Groups"],"security":[],"parameters":[{"in":"path","name":"id_shipping_group","required":true,"schema":{"format":"int64","type":"integer","minimum":1}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}}]}},"/units":{"get":{"operationId":"getUnits","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_UnitEmbedded_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of your units. Note that there may a delay of up to several\nminutes between adding a new unit and when it will be available through this endpoint.","summary":"Get a list of your units","tags":["Units"],"security":[],"parameters":[{"description":"Desired size of result set, maximum is 100","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":100,"minimum":0}},{"description":"Offset applied to result set","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Provided ID of your stock","in":"query","name":"id_offer","required":false,"schema":{"type":"string"}},{"description":"Our internal id_product","in":"query","name":"id_product","required":false,"schema":{"format":"int64","type":"integer","minimum":1}},{"description":"EAN, 13 or 14 digits","in":"query","name":"ean","required":false,"schema":{"type":"string"}},{"in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitAndProductEmbeddedEnum"}}},{"description":"Get only units which are fulfilled by the given type. <br/> The value `fulfilled_by_kaufland` is **DEPRECATED**.","in":"query","name":"fulfillment_type","required":false,"schema":{"default":["fulfilled_by_merchant"],"type":"array","items":{"$ref":"#/components/schemas/FulfillmentType"}}}]},"post":{"operationId":"createUnit","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Unit_"},"examples":{"Example 1":{"value":{"data":{"status":"INCOMPLETE","currency":"EUR","id_unit":1,"note":"string","condition":"NEW","listing_price":1,"minimum_price":1,"price":1,"id_offer":"string","id_product":1,"id_shipping_group":1,"id_warehouse":1,"amount":1,"date_inserted_iso":"2026-03-10T10:28:45.411Z","date_lastchange_iso":"2026-03-10T10:28:45.411Z","handling_time":0,"shipping_rate":0,"storefront":"de","transport_time_min":1,"transport_time_max":1,"fulfillment_type":"fulfilled_by_merchant","vat_indicator":"standard_rate","eco_participation":1,"battery_participation":1}}}}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Add a new unit for an existing product. You must specify either an <code>id_product</code>\nor an <code>ean</code> (or both), to identify the product to which the unit belongs.\nPlease notice that you have to specify a listing price greater than zero.","summary":"Add a unit","tags":["Units"],"security":[],"parameters":[{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitEmbeddedEnum"}}}],"requestBody":{"description":"Information about the unit that will be generated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitRequest","description":"Information about the unit that will be generated"}}}}}},"/units/{id_unit}":{"get":{"operationId":"getUnit","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Unit_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unit not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a unit by its <code>id_unit</code>","summary":"Get a unit by ID","tags":["Units"],"security":[],"parameters":[{"description":"Internal ID of Unit, unique across all Units","in":"path","name":"id_unit","required":true,"schema":{"format":"int64","type":"integer","minimum":1}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitAndProductEmbeddedEnum"}}}]},"patch":{"operationId":"patchUnit","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Unit_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unit not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Update some of the fields of a unit. Please notice that you have to specify a\nlisting price greater than zero.","summary":"Update some of the fields of a unit","tags":["Units"],"security":[],"parameters":[{"description":"Internal ID of Unit, unique across all Units","in":"path","name":"id_unit","required":true,"schema":{"format":"int64","type":"integer","minimum":1}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitEmbeddedEnum"}}}],"requestBody":{"description":"Update Object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitPatchRequest","description":"Update Object"}}}}},"delete":{"operationId":"deleteUnit","responses":{"204":{"description":"Success"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unit not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Delete a unit.","summary":"Delete a unit","tags":["Units"],"security":[],"parameters":[{"description":"Internal ID of Unit, unique across all Units","in":"path","name":"id_unit","required":true,"schema":{"format":"int64","type":"integer","minimum":1}},{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}}]}},"/units/bulk":{"post":{"operationId":"bulkUpdateUnits","responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitsBulkUpdateResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Update some fields of a given set of units. Please notice that you have to specify a\nlisting price greater than zero.\n\n<b>Important:</b> There are a couple of rules to keep in mind when using this endpoint, failure to respect these rules will result in the failure of the entire request:\n<ol>\n    <li>Your request <b>SHOULD NOT</b> have more than 150 units in the body, exceeding this limit will result in a 400 response and will fail the whole request.</li>\n    <li>The request <b>SHOULD NOT</b> contain duplicate units, if duplicates are detected the whole request is rejected.</li>\n</ol>","summary":"Update some fields of a given set of units","tags":["Units"],"security":[],"parameters":[{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"in":"query","name":"embedded","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitEmbeddedEnum"}}}],"requestBody":{"description":"Update Object","required":true,"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UnitsBulkUpdateRequest"},"type":"array","description":"Update Object"}}}}}},"/warehouses":{"get":{"operationId":"getWarehouses","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_Warehouse_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of your warehouses.","summary":"Get a list of your Warehouses","tags":["Warehouses"],"security":[],"parameters":[{"description":"Desired size of result set","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":30,"minimum":0}},{"description":"Offset applied to result set","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}}]},"post":{"operationId":"createWarehouse","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Warehouse_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Create a new warehouse.","summary":"Create a new Warehouse","tags":["Warehouses"],"security":[],"parameters":[],"requestBody":{"description":"Information about the warehouse that will be generated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseBodyRequest","description":"Information about the warehouse that will be generated"}}}}}},"/warehouses/{id_warehouse}":{"get":{"operationId":"getWarehouse","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Warehouse_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Warehouse not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Gets a warehouse by <code>id_warehouse</code>.","summary":"Get a warehouse by its ID","tags":["Warehouses"],"security":[],"parameters":[{"description":"Internal ID of Warehouse, unique across all Warehouses","in":"path","name":"id_warehouse","required":true,"schema":{"format":"int64","type":"integer","minimum":1}}]},"put":{"operationId":"updateWarehouse","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Warehouse_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Warehouse not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Update a warehouse.","summary":"Update a Warehouse","tags":["Warehouses"],"security":[],"parameters":[{"description":"Internal ID of Warehouse, unique across all Warehouses","in":"path","name":"id_warehouse","required":true,"schema":{"format":"int64","type":"integer","minimum":1}}],"requestBody":{"description":"Update Object","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseBodyRequest","description":"Update Object"}}}}},"delete":{"operationId":"deleteWarehouse","responses":{"204":{"description":"Success"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Warehouse not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Delete a warehouse.","summary":"Delete a warehouse","tags":["Warehouses"],"security":[],"parameters":[{"description":"Internal ID of Warehouse, unique across all Warehouses","in":"path","name":"id_warehouse","required":true,"schema":{"format":"int64","type":"integer","minimum":1}}]}},"/status/ping":{"get":{"operationId":"Ping","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_PingMessage_"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"A simple method you can call that will return a constant value as long as everything is good.","summary":"Ping the Marketplace Seller API by Kaufland","tags":["Status"],"security":[],"parameters":[]}},"/subscriptions":{"get":{"operationId":"GetSubscriptions","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_Subscription_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a list of your push notification subscriptions.","summary":"Get a list of your push notification subscriptions","tags":["Subscriptions"],"security":[],"parameters":[{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Event name","in":"query","name":"event_name","required":false,"schema":{"$ref":"#/components/schemas/SubscriptionEventName"}},{"description":"Desired size of result set","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","maximum":30,"minimum":0}},{"description":"Offset applied to result set","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}}]},"post":{"operationId":"AddSubscription","responses":{"201":{"description":"Successfully subscribed for an event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Subscription_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Create a new push notification subscription for an event. Using this endpoint will result in a callback verification request being sent to the given callback_url. See the Push Notifications documentation page for more information on push notifications and callback verification.","summary":"Subscribe for event","tags":["Subscriptions"],"security":[],"parameters":[{"description":"Parameter to select the affected storefront","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionRequest"}}}}}},"/subscriptions/{id_subscription}":{"get":{"operationId":"GetSubscription","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Subscription_"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get a push notification subscription by <code>id_subscription</code>.","summary":"Get a push notification subscription by ID","tags":["Subscriptions"],"security":[],"parameters":[{"in":"path","name":"id_subscription","required":true,"schema":{"$ref":"#/components/schemas/LongInteger"}}]},"patch":{"operationId":"UpdateSubscription","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Subscription_"}}}},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Update the fields of a push notification subscription. You can set the is_active flag to false to stop receiving notications for the subscription's event, or to true to re-enable a disabled subscription. If you change the value of the callback_url, the new callback_url will immediately receive a verification request. See the Callback URL Verification section of the Push Notifications documentation for details on validation requests.","summary":"Update subscription","tags":["Subscriptions"],"security":[],"parameters":[{"in":"path","name":"id_subscription","required":true,"schema":{"$ref":"#/components/schemas/LongInteger"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionRequest"}}}}},"delete":{"operationId":"DeleteSubscription","responses":{"204":{"description":"Successfully unsubscribed from an event"},"400":{"description":"Request parameters have invalid values","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Request authentication headers are corrupt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Request execution forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Deletes the specified push notification subscription from the database. To re-subscribe to the given event, you must use the add subscription endpoint.","summary":"Unsubscribe from event","tags":["Subscriptions"],"security":[],"parameters":[{"in":"path","name":"id_subscription","required":true,"schema":{"$ref":"#/components/schemas/LongInteger"}}]}}},"servers":[{"url":"/v2"}]}