{"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-batches","/problems/units/default-warehouse-forbidden","/problems/units/default-warehouse-not-found","/problems/shipping-groups/region-storefront-missing","/problems/shipping-groups/region-duplicate-countries","/problems/warehouses/missing-tax-information","/problems/warehouses/default-warehouse-setup-forbidden","/problems/warehouses/warehouse-country-immutable","/problems/import-files/file-too-large","/problems/shipping-labels/warehouse-missing","/problems/vouchers/terms-not-accepted","/problems/vouchers/status-change-not-allowed","/problems/vouchers/not-editable","/problems/vouchers/unresolvable-eans","/problems/volume-discounts/status-change-not-allowed","/problems/volume-discounts/unresolvable-eans","/problems/contacts/product-not-found","/problems/contacts/manufacturer-not-found","/problems/contacts/contact-not-found","/problems/contacts/invalid-contact-info"],"type":"string"},"ErrorResponse":{"properties":{"type":{"$ref":"#/components/schemas/ProblemType"},"errors":{"items":{"$ref":"#/components/schemas/ErrorDetails"},"type":"array"},"message":{"type":"string"}},"required":["type","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},"ContactType":{"enum":["manufacturer","eu-responsible-person"],"type":"string"},"PostalAddress":{"properties":{"street":{"type":"string","example":"Aachener Str"},"house_number":{"type":"string","example":"2"},"city":{"type":"string","example":"Koeln"},"postal_code":{"type":"string","nullable":true,"example":"50674"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"DE"},"address_additional":{"type":"string","nullable":true,"example":"Building C, 2nd floor"}},"required":["street","house_number","city","country_code"],"type":"object","additionalProperties":false},"ContactInfo":{"properties":{"email_address":{"type":"string","example":"support@example.com"},"website_url":{"type":"string","example":"https://example.com"},"phone_number":{"type":"string","nullable":true,"example":"+490000000"}},"type":"object","additionalProperties":false},"ContactDetails":{"properties":{"name":{"type":"string"},"postal_address":{"$ref":"#/components/schemas/PostalAddress"},"contact_info":{"$ref":"#/components/schemas/ContactInfo"}},"required":["name","postal_address","contact_info"],"type":"object","additionalProperties":false},"Contact":{"properties":{"contact_type":{"$ref":"#/components/schemas/ContactType"},"contact":{"$ref":"#/components/schemas/ContactDetails"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["contact_type","contact","created_at","updated_at"],"type":"object","additionalProperties":false},"ManufacturerContactList":{"properties":{"contacts":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"manufacturer_name":{"type":"string","description":"The canonical manufacturer name as stored in the Kaufland catalog, resolved from the value\nprovided in the path. Useful to confirm which entry was matched when a synonym or alternate\nspelling was used."}},"required":["contacts","manufacturer_name"],"type":"object","additionalProperties":false},"ApiResponse_ManufacturerContactList_":{"properties":{"data":{"$ref":"#/components/schemas/ManufacturerContactList"}},"required":["data"],"type":"object","additionalProperties":false},"ApiResponse_Contact_":{"properties":{"data":{"$ref":"#/components/schemas/Contact"}},"required":["data"],"type":"object","additionalProperties":false},"PostalAddressInput":{"properties":{"street":{"type":"string","example":"Aachener Str","minLength":1,"maxLength":255},"house_number":{"type":"string","example":"2","minLength":1,"maxLength":50},"city":{"type":"string","example":"Koeln","minLength":1,"maxLength":255},"postal_code":{"type":"string","nullable":true,"description":"Required when `country_code` is an EU member state.","example":"50674","minLength":1,"maxLength":20},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code.","example":"DE","pattern":"^[A-Za-z]{2}$"},"address_additional":{"type":"string","nullable":true,"example":"Building C, 2nd floor","minLength":1,"maxLength":255}},"required":["street","house_number","city","country_code"],"type":"object","additionalProperties":false},"ContactInfoInput":{"properties":{"email_address":{"type":"string","description":"At least one of `email_address` or `website_url` must be provided.","example":"support@example.com","maxLength":255},"website_url":{"type":"string","description":"At least one of `email_address` or `website_url` must be provided.","example":"https://example.com","maxLength":2048},"phone_number":{"type":"string","nullable":true,"example":"+490000000","minLength":1,"maxLength":50}},"type":"object","additionalProperties":false},"ContactInputRequest":{"properties":{"name":{"type":"string","example":"Kiosk am Aachener Str","minLength":1,"maxLength":255},"postal_address":{"$ref":"#/components/schemas/PostalAddressInput"},"contact_info":{"$ref":"#/components/schemas/ContactInfoInput"}},"required":["name","postal_address","contact_info"],"type":"object","additionalProperties":false},"ContactList":{"properties":{"contacts":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}},"required":["contacts"],"type":"object","additionalProperties":false},"ApiResponse_ContactList_":{"properties":{"data":{"$ref":"#/components/schemas/ContactList"}},"required":["data"],"type":"object","additionalProperties":false},"VoucherStatus":{"enum":["new","active","inactive","expired","consumed","deleted","unknown"],"type":"string"},"Voucher":{"properties":{"id_voucher":{"type":"number","format":"double"},"title":{"type":"string"},"status":{"$ref":"#/components/schemas/VoucherStatus"},"storefront":{"type":"string"},"discount_type":{"type":"string"},"discount_amount":{"type":"number","format":"double"},"begin_at":{"type":"string"},"end_at":{"type":"string"},"created_at":{"type":"string"},"usage_limit":{"type":"number","format":"double"},"export_to_third_parties":{"type":"boolean"},"number_of_redeemed_vouchers":{"type":"number","format":"double"},"voucher_fee":{"type":"number","format":"double"},"total_sales":{"type":"number","format":"double"},"acos":{"type":"number","format":"double"},"roas":{"type":"number","format":"double"},"products_count":{"type":"number","format":"double"}},"required":["id_voucher","title","status","storefront","discount_type","discount_amount","begin_at","end_at","created_at","usage_limit","export_to_third_parties","number_of_redeemed_vouchers","voucher_fee","total_sales","acos","roas","products_count"],"type":"object","additionalProperties":false},"ApiResponse_Voucher_":{"properties":{"data":{"$ref":"#/components/schemas/Voucher"}},"required":["data"],"type":"object","additionalProperties":false},"Storefront":{"enum":["de","cz","sk","pl","at","fr","it","es","nl"],"type":"string"},"DiscountType":{"enum":["PERCENTAGE","ABSOLUTE"],"type":"string"},"CreateVoucherRequest":{"properties":{"title":{"type":"string"},"storefront":{"$ref":"#/components/schemas/Storefront"},"discount_type":{"$ref":"#/components/schemas/DiscountType"},"discount_amount":{"type":"number","format":"double"},"begin_at":{"type":"string"},"end_at":{"type":"string"},"usage_limit":{"type":"number","format":"double"},"products":{"items":{"type":"number","format":"double"},"type":"array"},"eans":{"items":{"type":"string"},"type":"array"},"export_to_third_parties":{"type":"boolean"}},"required":["title","storefront","discount_type","discount_amount","begin_at","end_at","usage_limit"],"type":"object","additionalProperties":false},"CollectionApiResponse_Voucher_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Voucher"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"VoucherProduct":{"properties":{"id_product":{"type":"number","format":"double"},"acos":{"type":"number","format":"double","description":"Advertising Cost of Sales for this product, expressed as a percentage.\nComputed as `(voucher_fee_for_product / total_sales_for_product) * 100`.\nLower values indicate a more cost-efficient voucher. `0` when the product has not generated any sales through the voucher."},"roas":{"type":"number","format":"double","description":"Return on Ad Spend for this product, expressed as a ratio.\nComputed as `total_sales_for_product / voucher_fee_for_product`.\nHigher values indicate a higher return per unit of voucher cost. `0` when the product has not generated any sales through the voucher."},"number_of_redeemed_vouchers":{"type":"number","format":"double"}},"required":["id_product","acos","roas","number_of_redeemed_vouchers"],"type":"object","additionalProperties":false},"CollectionApiResponse_VoucherProduct_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/VoucherProduct"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"VoucherStatus.INACTIVE":{"enum":["inactive"],"type":"string"},"UpdateVouchersStatusRequest":{"properties":{"ids":{"items":{"type":"number","format":"double"},"type":"array"},"status":{"$ref":"#/components/schemas/VoucherStatus.INACTIVE"}},"required":["ids","status"],"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},"SimilarProductVoucher":{"properties":{"discount_amount":{"type":"integer","format":"int32","description":"Discount amount; either a percentage or a minor-currency-unit amount depending on discount_type"},"discount_type":{"type":"string","enum":["percent","fixed"]},"discounted_price":{"type":"integer","format":"int32","description":"Price after the voucher discount is applied, in minor units of the group currency"}},"required":["discount_amount","discount_type","discounted_price"],"type":"object","additionalProperties":false},"SimilarProductGroupLadderEntry":{"properties":{"price_rank":{"type":"integer","format":"int32","description":"Personalised rank after the seller's other offers are removed; positions may have gaps when unavailable offers are omitted"},"seller":{"type":"string","description":"Name of the competing seller"},"id_product":{"type":"integer","format":"int32","description":"Kaufland's product ID of the competing product"},"product_name":{"type":"string","description":"Product title"},"ean":{"type":"string","nullable":true,"description":"Main EAN of the product, if available"},"price":{"type":"integer","format":"int32","description":"Offer price, in minor units of the group currency"},"shipping_cost":{"type":"integer","format":"int32","description":"Shipping cost in minor units of the group currency"},"delivery_time_min":{"type":"integer","format":"int32","description":"Minimum delivery time in days"},"delivery_time_max":{"type":"integer","format":"int32","description":"Maximum delivery time in days"},"ratings_count":{"type":"integer","format":"int32","description":"Number of ratings for the offer"},"average_rating":{"type":"number","format":"double","description":"Average review rating for the offer"},"manufacturer_name":{"type":"string","nullable":true,"description":"Manufacturer name, if available"},"voucher":{"allOf":[{"$ref":"#/components/schemas/SimilarProductVoucher"}],"nullable":true,"description":"Voucher applied to the offer, if available","type":"object"},"is_excluded":{"type":"boolean","description":"Whether the offer is excluded from configured competitor calculations; excluded offers remain visible in the ladder"},"is_own_offer":{"type":"boolean","description":"Whether this offer belongs to the authenticated seller"}},"required":["price_rank","seller","id_product","product_name","ean","price","shipping_cost","delivery_time_min","delivery_time_max","ratings_count","average_rating","manufacturer_name","voucher","is_excluded","is_own_offer"],"type":"object","additionalProperties":false},"SimilarProductGroup":{"properties":{"group_id":{"type":"string","description":"Identifier of the similarity group"},"storefront":{"$ref":"#/components/schemas/Storefront","description":"Storefront the group belongs to"},"currency":{"$ref":"#/components/schemas/Currency","description":"ISO 4217 currency of all monetary values in the group"},"group_demand":{"type":"string","enum":["high","low"],"description":"Relative demand of the group"},"own_price_rank":{"type":"integer","format":"int32","description":"Personalised rank after the seller's other offers are removed; positions may have gaps when unavailable offers are omitted"},"own_sales_rank":{"type":"integer","format":"int32","nullable":true,"description":"The seller's sales rank within the group, or null if not available"},"own_share":{"type":"string","enum":["high","low"],"description":"Seller GMV share bucket within the group"},"gap_to_best_price":{"type":"integer","format":"int32","description":"Price gap to the best offer in the group, in minor units of currency"},"number_of_competitors":{"type":"integer","format":"int32","description":"Number of competing offers in the group, before the 250-offer ladder cap is applied; may be\ngreater than ladder.length"},"easy_win":{"type":"boolean","description":"Whether the seller price is close enough to the current rank #1 offer that a small change could take the lead"},"recommendation":{"type":"string","enum":["focus","defend","grow","maintain"],"nullable":true,"description":"Recommendation derived from group_demand and own_share: focus (high demand, low share),\ndefend (high demand, high share), grow (low demand, low share), or maintain (low demand,\nhigh share); null when demand or share cannot be determined for the group"},"ladder":{"items":{"$ref":"#/components/schemas/SimilarProductGroupLadderEntry"},"type":"array","description":"Personalised-rank-sorted competitor ladder, limited to 250 available offers","maxItems":250}},"required":["group_id","storefront","currency","group_demand","own_price_rank","own_sales_rank","own_share","gap_to_best_price","number_of_competitors","easy_win","recommendation","ladder"],"type":"object","additionalProperties":false},"CollectionApiResponse_SimilarProductGroup_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SimilarProductGroup"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"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"},"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"},"OwnBrandBuyboxUnit":{"properties":{"buybox_rank":{"type":"integer","format":"int32","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"},"condition":{"$ref":"#/components/schemas/UnitCondition","description":"The exact condition of the unit, using the same condition values as inventory units"},"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","condition"],"type":"object","additionalProperties":false},"OwnBrandOffersRankings":{"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":"integer","format":"int32","description":"Total number of offers for the given product"},"units":{"items":{"$ref":"#/components/schemas/OwnBrandBuyboxUnit"},"type":"array"}},"required":["id_product","condition","storefront","num_units","units"],"type":"object","additionalProperties":false},"ApiResponse_OwnBrandOffersRankings-Array_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OwnBrandOffersRankings"},"type":"array"}},"required":["data"],"type":"object","additionalProperties":false},"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},"BuyboxUnit":{"properties":{"buybox_rank":{"type":"integer","format":"int32","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"},"condition":{"$ref":"#/components/schemas/UnitCondition","description":"The exact condition of the unit, using the same condition values as inventory units"},"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","condition"],"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":"integer","format":"int32","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},"CommissionRateStatus":{"description":"Status of the commission rate lookup for a requested EAN + storefront pair.\n\n- `OK`: a commission rate is available for the product and is returned in\n  `commission_rate_estimate`.\n- `NOT_FOUND`: no product could be located for the requested EAN + storefront.\n- `NO_COMMISSION_RATE`: the product exists but no commission rate is configured\n  for it; `commission_rate_estimate` will be absent.","enum":["OK","NOT_FOUND","NO_COMMISSION_RATE"],"type":"string"},"CommissionRateEstimate":{"properties":{"variable_fee":{"type":"number","format":"double","description":"Variable fee component of the commission, expressed as a percentage.","example":7},"fixed_fee":{"type":"integer","format":"int32","description":"Fixed fee component of the commission, expressed in minor units of the\nstorefront currency (e.g. cents for EUR).","example":0}},"required":["variable_fee","fixed_fee"],"type":"object","additionalProperties":false},"CommissionRate":{"properties":{"ean":{"type":"string","example":"4006381333931"},"storefront":{"$ref":"#/components/schemas/Storefront"},"status":{"$ref":"#/components/schemas/CommissionRateStatus"},"commission_rate_estimate":{"$ref":"#/components/schemas/CommissionRateEstimate","description":"Estimated commission rate for the product at the time of the request.\n\nThe value is called an *estimate* because it reflects the rate currently\nconfigured for the product; the commission ultimately charged is determined\nat invoice time and may differ. Present only when `status` is `OK`."}},"required":["ean","storefront","status"],"type":"object","additionalProperties":false},"CollectionApiResponse_CommissionRate_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CommissionRate"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"type":"object","additionalProperties":false},"CommissionRateLookupRequest":{"properties":{"eans":{"items":{"type":"string"},"type":"array","description":"List of EANs to look up commission rates for, within the storefront\ngiven by the `storefront` query parameter. Must contain between 1 and\n50 EANs.","example":["4006381333931","3607345809915","0000000000000"],"minItems":1,"maxItems":50}},"required":["eans"],"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},"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":{"discounts":{"items":{"properties":{"usage_type":{"type":"string","description":"Currently possible values are \"voucher\" and \"volume\"","example":"voucher"},"discount_value":{"type":"integer","format":"int32","description":"Absolute discount amount in the order unit's currency subunit (e.g. cents)","example":500}},"required":["usage_type","discount_value"],"type":"object"},"type":"array"},"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":["discounts","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},"discounts":{"items":{"properties":{"usage_type":{"type":"string","example":"voucher"},"discount_value":{"type":"integer","format":"int32","description":"Absolute discount amount in the order unit's currency subunit (e.g. cents)","example":500}},"required":["usage_type","discount_value"],"type":"object"},"type":"array"}},"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","discounts"],"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},"OrderUnitShippingGroup":{"properties":{"id_shipping_group":{"type":"integer","format":"int32","nullable":true,"description":"The shipping group that applied to the order unit when the order was placed.\nNull when no shipping group was captured for the order unit at that time."}},"required":["id_shipping_group"],"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},"discounts":{"items":{"properties":{"usage_type":{"type":"string","example":"voucher"},"discount_value":{"type":"integer","format":"int32","description":"Absolute discount amount in the order unit's currency subunit (e.g. cents)","example":500}},"required":["usage_type","discount_value"],"type":"object"},"type":"array"},"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},"shipping_group":{"$ref":"#/components/schemas/OrderUnitShippingGroup","description":"The attribute is only responded when explicitly requested as an embedded field"}},"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","discounts"],"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","shipping_group"],"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},"ShippingAddressType":{"enum":["SHIPPING_ADDRESS_HOME","SHIPPING_ADDRESS_GENERIC_PUDO","SHIPPING_ADDRESS_DPD_PUDO","SHIPPING_ADDRESS_DHL_PUDO","SHIPPING_ADDRESS_PACKETA_PUDO"],"type":"string"},"HomeAddressData":{"properties":{"first_name":{"type":"string","example":"Max"},"last_name":{"type":"string","example":"Mustermann"},"company_name":{"type":"string","example":"Kiosk am Aachener Str"},"street":{"type":"string","example":"Aachener Str"},"house_number":{"type":"string","example":"2"},"postcode":{"type":"string","example":"50674"},"city":{"type":"string","example":"Koeln"},"phone":{"type":"string","example":"+490000000"},"country":{"type":"string","example":"DE"},"additional_field":{"type":"string","example":"Leave at the front door if not home"}},"type":"object","additionalProperties":false},"PickupPointAddressData":{"properties":{"first_name":{"type":"string","example":"Max"},"last_name":{"type":"string","example":"Mustermann"},"company_name":{"type":"string","example":"Kiosk am Aachener Str"},"street":{"type":"string","example":"Aachener Str"},"house_number":{"type":"string","example":"2"},"postcode":{"type":"string","example":"50674"},"city":{"type":"string","example":"Koeln"},"phone":{"type":"string","example":"+490000000"},"country":{"type":"string","example":"DE"},"additional_field":{"type":"string","example":"Leave at the front door if not home"},"pickup_location_id":{"type":"string","example":"DE37860"}},"type":"object","additionalProperties":false},"DhlPackstationAddressData":{"properties":{"first_name":{"type":"string","example":"Max"},"last_name":{"type":"string","example":"Mustermann"},"company_name":{"type":"string","example":"Kiosk am Aachener Str"},"street":{"type":"string","example":"Aachener Str"},"house_number":{"type":"string","example":"2"},"postcode":{"type":"string","example":"50674"},"city":{"type":"string","example":"Koeln"},"phone":{"type":"string","example":"+490000000"},"country":{"type":"string","example":"DE"},"additional_field":{"type":"string","example":"Leave at the front door if not home"},"pickup_location_id":{"type":"string","example":"DE37860"},"dhl_post_number":{"type":"string","example":"12345678"}},"type":"object","additionalProperties":false},"PacketaPickupPointAddressData":{"properties":{"first_name":{"type":"string","example":"Max"},"last_name":{"type":"string","example":"Mustermann"},"company_name":{"type":"string","example":"Kiosk am Aachener Str"},"street":{"type":"string","example":"Aachener Str"},"house_number":{"type":"string","example":"2"},"postcode":{"type":"string","example":"50674"},"city":{"type":"string","example":"Koeln"},"phone":{"type":"string","example":"+490000000"},"country":{"type":"string","example":"DE"},"additional_field":{"type":"string","example":"Leave at the front door if not home"},"pickup_location_id":{"type":"string","example":"DE37860"},"pickup_location_name":{"type":"string","example":"My Parcel Shop"}},"type":"object","additionalProperties":false},"DpdParcelShopAddressData":{"properties":{"first_name":{"type":"string","example":"Max"},"last_name":{"type":"string","example":"Mustermann"},"company_name":{"type":"string","example":"Kiosk am Aachener Str"},"street":{"type":"string","example":"Aachener Str"},"house_number":{"type":"string","example":"2"},"postcode":{"type":"string","example":"50674"},"city":{"type":"string","example":"Koeln"},"phone":{"type":"string","example":"+490000000"},"country":{"type":"string","example":"DE"},"additional_field":{"type":"string","example":"Leave at the front door if not home"},"dpd_pudo_id":{"type":"string","example":"DE37860"},"dpd_parcel_shop_id":{"type":"string","example":"428256"}},"type":"object","additionalProperties":false},"ShippingAddressDetails":{"properties":{"type":{"$ref":"#/components/schemas/ShippingAddressType","example":"SHIPPING_ADDRESS_HOME"},"data":{"anyOf":[{"$ref":"#/components/schemas/HomeAddressData"},{"$ref":"#/components/schemas/PickupPointAddressData"},{"$ref":"#/components/schemas/DhlPackstationAddressData"},{"$ref":"#/components/schemas/PacketaPickupPointAddressData"},{"$ref":"#/components/schemas/DpdParcelShopAddressData"}]}},"required":["type","data"],"type":"object","additionalProperties":false},"ShippingAddress":{"properties":{"id_order":{"type":"string","example":"MB7UWLD"},"id_order_unit":{"type":"integer","format":"int32","example":12345},"address_data":{"$ref":"#/components/schemas/ShippingAddressDetails"}},"required":["address_data"],"type":"object","additionalProperties":false},"CollectionApiResponse_ShippingAddress_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ShippingAddress"},"type":"array"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data"],"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","description":"The \"effective\" currency which is applied on the customer side. The currency of the storefront"},"preferred_currency":{"allOf":[{"$ref":"#/components/schemas/Currency"}],"nullable":true,"description":"The currency, chosen for defining the Shipping Cost in the Shipping Group by Seller\ne.g. seller has a preferred currency, PLN zloty, and define the shipping cost in zloty for the DE storefront.","example":"EUR"},"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","preferred_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},"manufacturer_guarantee_years":{"type":"integer","format":"int32","nullable":true,"description":"Duration of the manufacturer guarantee in years.","minimum":1,"maximum":99},"is_live":{"type":"boolean","description":"Whether the unit is currently live on the storefront"}},"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","manufacturer_guarantee_years","is_live"],"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},"manufacturer_guarantee_years":{"type":"integer","format":"int32","nullable":true,"description":"Duration of the manufacturer guarantee in years.","minimum":1,"maximum":99},"is_live":{"type":"boolean","description":"Whether the unit is currently live on the storefront"}},"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","manufacturer_guarantee_years","is_live"],"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, es, nl 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},"manufacturer_guarantee_years":{"type":"integer","format":"int32","nullable":true,"description":"Duration of the manufacturer guarantee in years. Omitting the field sets it to `null`.","minimum":1,"maximum":99}},"required":["handling_time","listing_price","id_offer"],"type":"object","additionalProperties":false},"UnitEmbeddedEnum":{"enum":["eco_participation","battery_participation",""],"type":"string"},"UnitNotLiveReason":{"enum":["stock_update_needed","offer_paused","account_documentation_needed","product_data_incomplete","weee_number_needed","recommerce_eligibility","product_data_mismatch","regulatory_review","unverified_authenticity","image_usage_issue","price_check_needed","brand_authorization_issue","other_compliance_issue","intellectual_property_issue","divid_number_needed","idu_number_needed","epr_number_needed","gpsr_info_needed","ioss_threshold","eco_fee_pending","unknown_reason"],"type":"string"},"UnitsStatusReason":{"properties":{"reason":{"anyOf":[{"$ref":"#/components/schemas/UnitNotLiveReason"},{"type":"string"}],"description":"Stable identifier of the reason. New values may be added in future releases without prior\nnotice - this is a non-breaking change. Use `reason_description` as a human-readable fallback\nwhen a `reason` value is not recognized."},"reason_description":{"type":"string","description":"Human-readable description of the reason, in English.\nIntended to be shown to the seller, not parsed by software."},"details_url":{"type":"string","description":"Link with more information for the seller. Only present where available - its absence is not an error."}},"required":["reason","reason_description"],"type":"object","additionalProperties":false},"UnitsStatusEntry":{"properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"status_code":{"type":"number","enum":[200],"nullable":false,"description":"Always `200` for a unit that was found"},"is_live":{"type":"boolean","description":"Whether the unit is currently live on the storefront. See `reasons` for why it is not."},"reasons":{"items":{"$ref":"#/components/schemas/UnitsStatusReason"},"type":"array","description":"Empty when is_live is true."}},"required":["id_unit","status_code","is_live","reasons"],"type":"object","additionalProperties":false},"UnitsStatusNotFound":{"properties":{"id_unit":{"type":"integer","format":"int64","minimum":1},"status_code":{"type":"number","enum":[404],"nullable":false,"description":"Always `404` when no unit with this `id_unit` exists on the requested `storefront`."},"message":{"type":"string","description":"Always `Unit not found`. The lookup is scoped to the requested `storefront`, so a unit that\nis listed on a different storefront is also reported as not found."}},"required":["id_unit","status_code","message"],"type":"object","additionalProperties":false},"ApiResponse_Array_UnitsStatusEntry-or-UnitsStatusNotFound__":{"properties":{"data":{"items":{"anyOf":[{"$ref":"#/components/schemas/UnitsStatusEntry"},{"$ref":"#/components/schemas/UnitsStatusNotFound"}]},"type":"array"}},"required":["data"],"type":"object","additionalProperties":false},"UnitsStatusRequest":{"properties":{"unit_ids":{"items":{"type":"integer","format":"int64"},"type":"array","description":"List of unit IDs to look up. At most 20 per request; duplicates count towards that limit\nand are returned only once. Each ID must be an integer greater than zero.","minItems":1,"maxItems":20}},"required":["unit_ids"],"type":"object","additionalProperties":false},"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, es, nl 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},"manufacturer_guarantee_years":{"type":"integer","format":"int32","nullable":true,"description":"Duration of the manufacturer guarantee in years. Send `null` to remove an existing value; omitting the field leaves the current value unchanged.","minimum":1,"maximum":99}},"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","vat_indicator":"standard_rate","manufacturer_guarantee_years":null,"is_live":false}}]}},"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","item_unit_live","item_unit_not_live","buy_box_changed"],"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.44.0","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"}}}}},"description":"Returns assortment coverage insights for the seller, including buybox prices,\nsales/external rank, and external demand signals per product.","summary":"Get assortment coverage insights","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}}]}},"/contacts/manufacturers/{manufacturer_name}":{"get":{"operationId":"GetManufacturerContacts","responses":{"200":{"description":"Contacts retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ManufacturerContactList_"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The name could not be resolved to any known manufacturer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Returns the authenticated seller's GPSR contacts for a manufacturer.\n\n`manufacturer_name` is resolved server-side against the Kaufland product catalog, including\nconfigured synonyms, so alternate spellings and capitalisation variants (e.g. `BOSCH`,\n`Bosch`, `bosch`) are accepted and transparently mapped to the canonical entry — returned\nin the response as `manufacturer_name`.\n\nAt most one contact per `contact_type` (`manufacturer` and/or `eu-responsible-person`) is\nreturned. Returns an empty list when no contacts have been set.","summary":"List the authenticated seller's contacts for a manufacturer.","tags":["GPSR Manufacturer Contacts"],"security":[],"parameters":[{"description":"Manufacturer name as it appears in the Kaufland product catalog.","in":"path","name":"manufacturer_name","required":true,"schema":{"type":"string"},"example":"Bosch"}]}},"/contacts/manufacturers/{manufacturer_name}/{contact_type}":{"put":{"operationId":"UpsertManufacturerContact","responses":{"200":{"description":"Contact saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Contact_"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The name could not be resolved to any known manufacturer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Downstream rejected `contact_info` as invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Creates or fully replaces the seller's contact of the given type for a manufacturer.\n\nIdempotent — if a contact of this type already exists for the manufacturer it is replaced\nin full. `contact_info` must contain at least one of `email_address` or `website_url`.","summary":"Create or replace the seller's contact for a manufacturer.","tags":["GPSR Manufacturer Contacts"],"security":[],"parameters":[{"description":"Manufacturer name as it appears in the Kaufland product catalog.","in":"path","name":"manufacturer_name","required":true,"schema":{"type":"string"},"example":"Bosch"},{"description":"Which contact type to address.","in":"path","name":"contact_type","required":true,"schema":{"$ref":"#/components/schemas/ContactType"}}],"requestBody":{"description":"Contact details. `postal_address.country_code` is required to be an EU\nmember state when `contact_type` is `eu-responsible-person`, and `postal_address.postal_code`\nis required whenever `country_code` is an EU member state.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactInputRequest","description":"Contact details. `postal_address.country_code` is required to be an EU\nmember state when `contact_type` is `eu-responsible-person`, and `postal_address.postal_code`\nis required whenever `country_code` is an EU member state."}}}}},"delete":{"operationId":"DeleteManufacturerContact","responses":{"204":{"description":"Contact deleted"},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The name could not be resolved to any known manufacturer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Removes the seller's contact of the given type for a manufacturer.\n\nIdempotent — succeeds even if no contact of this type was set for the manufacturer.","summary":"Remove the seller's contact for a manufacturer.","tags":["GPSR Manufacturer Contacts"],"security":[],"parameters":[{"description":"Manufacturer name as it appears in the Kaufland product catalog.","in":"path","name":"manufacturer_name","required":true,"schema":{"type":"string"},"example":"Bosch"},{"description":"Which contact type to address.","in":"path","name":"contact_type","required":true,"schema":{"$ref":"#/components/schemas/ContactType"}}]}},"/contacts/products/{ean}":{"get":{"operationId":"GetProductContacts","responses":{"200":{"description":"Contacts retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_ContactList_"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The EAN could not be resolved to a product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Returns the authenticated seller's GPSR contacts for a product, identified by EAN.\n\nAt most one contact per `contact_type` (`manufacturer` and/or `eu-responsible-person`) is\nreturned. Returns an empty list when no contacts have been set.","summary":"List the authenticated seller's contacts for a product.","tags":["GPSR Product Contacts"],"security":[],"parameters":[{"description":"European Article Number of the product.","in":"path","name":"ean","required":true,"schema":{"type":"string"},"example":"4006381333931"}]}},"/contacts/products/{ean}/{contact_type}":{"put":{"operationId":"UpsertProductContact","responses":{"200":{"description":"Contact saved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Contact_"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The EAN could not be resolved to a product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Downstream rejected `contact_info` as invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Creates or fully replaces the seller's contact of the given type for a product.\n\nIdempotent — if a contact of this type already exists for the product it is replaced in\nfull. `contact_info` must contain at least one of `email_address` or `website_url`.","summary":"Create or replace the seller's contact for a product.","tags":["GPSR Product Contacts"],"security":[],"parameters":[{"description":"European Article Number of the product.","in":"path","name":"ean","required":true,"schema":{"type":"string"},"example":"4006381333931"},{"description":"Which contact type to address.","in":"path","name":"contact_type","required":true,"schema":{"$ref":"#/components/schemas/ContactType"}}],"requestBody":{"description":"Contact details. `postal_address.country_code` is required to be an EU\nmember state when `contact_type` is `eu-responsible-person`, and `postal_address.postal_code`\nis required whenever `country_code` is an EU member state.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactInputRequest","description":"Contact details. `postal_address.country_code` is required to be an EU\nmember state when `contact_type` is `eu-responsible-person`, and `postal_address.postal_code`\nis required whenever `country_code` is an EU member state."}}}}},"delete":{"operationId":"DeleteProductContact","responses":{"204":{"description":"Contact deleted"},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The EAN could not be resolved to a product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Removes the seller's contact of the given type for a product.\n\nIdempotent — succeeds even if no contact of this type was set for the product.","summary":"Remove the seller's contact for a product.","tags":["GPSR Product Contacts"],"security":[],"parameters":[{"description":"European Article Number of the product.","in":"path","name":"ean","required":true,"schema":{"type":"string"},"example":"4006381333931"},{"description":"Which contact type to address.","in":"path","name":"contact_type","required":true,"schema":{"$ref":"#/components/schemas/ContactType"}}]}},"/vouchers":{"post":{"operationId":"CreateVoucher","responses":{"201":{"description":"Voucher created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Voucher_"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Terms and Conditions not accepted for the given storefront.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Creates a discount voucher for a given storefront.\n\n**Prerequisites:**\n\n- Vouchers apply only to **new** products. Used products are not eligible: a voucher is never offered on a used-product PDP and does not discount used-condition units, even if their product ID or EAN is included in the voucher.\n\n`title` is the display name of the voucher.\n\n`storefront` is the storefront code (e.g. `de`, `cz`, `sk`) for which the voucher is valid.\n\n`discount_type` defines how the discount is applied. Must be one of: `PERCENTAGE`, `ABSOLUTE`.\n\n`discount_amount` is the value of the discount. For `PERCENTAGE` discounts the maximum allowed value is `85`.\n\n`begin_at` and `end_at` define the validity period of the voucher. Both must be valid dates in `YYYY-MM-DD` format. `begin_at` must be today or later, `end_at` must be today or later, and `end_at` must be on or after `begin_at` (the same date can be used for both to create a voucher active for today only).\n\n`usage_limit` is the maximum number of times the voucher can be redeemed. Must be at least `1`.\n\nEither `products` (a list of product IDs) or `eans` (a list of EAN strings) must be provided to scope the voucher to specific items.\n\nA single voucher can cover at most **3000 items**. This applies to `products` and `eans` individually and to the two lists combined; exceeding it returns `400`. To cover a larger assortment, split it across several vouchers.\n\n**Vouchers are scoped per product, not per unit.** Most SellerAPI endpoints operate on units (a seller's specific listing of an item), but a voucher created here applies to **every new-condition unit owned by the calling seller** whose item matches one of the provided product IDs or EANs. There is no way to scope a voucher to a single unit.\n\n`export_to_third_parties` is an optional flag that controls whether the voucher is shared with third-party price-comparison portals. Defaults to `false`.","summary":"Create a new discount voucher.","tags":["Vouchers"],"security":[],"parameters":[],"requestBody":{"description":"Request body with voucher configuration.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVoucherRequest","description":"Request body with voucher configuration."},"example":{"title":"Christmas Sale","storefront":"de","discount_type":"PERCENTAGE","discount_amount":10,"begin_at":"2025-12-16","end_at":"2025-12-20","usage_limit":100,"products":[545476015,322791766],"export_to_third_parties":false}}}}},"get":{"operationId":"GetVouchers","responses":{"200":{"description":"Vouchers list retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_Voucher_"}}}},"400":{"description":"One or more query parameters have invalid or missing values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Returns a paginated list of vouchers. All parameters are optional.\n\n`storefront` filters by one or more storefront codes. Pass the parameter multiple times to filter by several storefronts (e.g. `?storefront=de&storefront=cz`). When omitted, vouchers across all storefronts are returned.\n\n`status` filters by voucher lifecycle state. Pass the parameter multiple times to filter by several statuses (e.g. `?status=active&status=new`). Allowed values: `new`, `active`, `inactive`, `expired`, `consumed`, `deleted`. When omitted, vouchers of all statuses are returned.\n\n`search_term` filters by campaign name or voucher ID.\n\n`id_product` filters vouchers that apply to one or more specific products. Pass the parameter multiple times to filter by several products (e.g. `?id_product=123&id_product=456`). When omitted, vouchers for all products are returned.\n\n`ean` filters vouchers that apply to one or more products identified by EAN. Pass the parameter multiple times to filter by several EANs (e.g. `?ean=4006381333931&ean=4006381333948`). When omitted, vouchers for all products are returned.\n\n`sort` orders results in the form `field:direction`, where `field` is one of `products`, `redemptions`, `beginAt`, `createdAt`, `totalSales`, `roas`, `acos` (`products` sorts by the number of products attached to the voucher), and `direction` is `asc` or `desc` (e.g. `?sort=redemptions:desc`).\n\n`offset` is the number of vouchers to skip (default: 0).\n\n`limit` must be between 1 and 100 (default: 30). `offset` must be a multiple of `limit`.","summary":"Get the list of vouchers.","tags":["Vouchers"],"security":[],"parameters":[{"description":"Filter by one or more storefront codes. When omitted, all storefronts are included.","in":"query","name":"storefront","required":false,"schema":{"default":[],"type":"array","items":{"type":"string"}}},{"description":"Filter by one or more voucher statuses. When omitted, all statuses are included.","in":"query","name":"status","required":false,"schema":{"default":[],"type":"array","items":{"type":"string"}}},{"description":"Filter by campaign name or voucher ID.","in":"query","name":"search_term","required":false,"schema":{"type":"string"}},{"description":"Filter by one or more product IDs. When omitted, vouchers for all products are included.","in":"query","name":"id_product","required":false,"schema":{"default":[],"type":"array","items":{"type":"number","format":"double"}}},{"description":"Filter by one or more EANs.","in":"query","name":"ean","required":false,"schema":{"default":[],"type":"array","items":{"type":"string"}}},{"description":"Number of vouchers to skip. Must be a non-negative integer.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}},{"description":"Number of vouchers to return per page. Must be between 1 and 100.","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","minimum":1,"maximum":100}},{"description":"Sort results in the form `field:direction`.","in":"query","name":"sort","required":false,"schema":{"type":"string"}}]},"delete":{"operationId":"DeleteVoucher","responses":{"204":{"description":"Vouchers deleted"},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"One or more vouchers were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Permanently deletes one or more discount vouchers by their IDs.\n\n`id` is repeatable: pass the parameter multiple times to delete several vouchers in one call (e.g. `?id=42&id=43`). Between 1 and 100 IDs must be provided.","summary":"Delete one or more discount vouchers.","tags":["Vouchers"],"security":[],"parameters":[{"description":"One or more voucher IDs to delete.","in":"query","name":"id","required":false,"schema":{"default":[],"type":"array","items":{"type":"number","format":"double"}}}]},"patch":{"operationId":"UpdateVouchersStatus","responses":{"200":{"description":"Vouchers updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_Voucher_"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"One or more vouchers were not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Updates the lifecycle status of one or more discount vouchers in a single call.\n\nCurrently the only supported transition is setting `status` to `inactive`, which deactivates the listed vouchers.","summary":"Update the status of one or more discount vouchers.","tags":["Vouchers"],"security":[],"parameters":[],"requestBody":{"description":"Request body containing the IDs of the vouchers to update and the target status.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVouchersStatusRequest","description":"Request body containing the IDs of the vouchers to update and the target status."},"example":{"ids":[42,43],"status":"inactive"}}}}}},"/vouchers/{id_voucher}":{"get":{"operationId":"GetVoucher","responses":{"200":{"description":"Voucher retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Voucher_"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Voucher not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Retrieves the full details and performance statistics of a specific voucher,\nexcluding its products. Use `GET /vouchers/{id_voucher}/products` to retrieve\nthe associated products with pagination.","summary":"Get a discount voucher by ID.","tags":["Vouchers"],"security":[],"parameters":[{"description":"The ID of the voucher to retrieve.","in":"path","name":"id_voucher","required":true,"schema":{"format":"double","type":"number"}}]}},"/vouchers/{id_voucher}/products":{"get":{"operationId":"GetVoucherProducts","responses":{"200":{"description":"Voucher products retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_VoucherProduct_"}}}},"400":{"description":"Invalid query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Voucher not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unexpected server-side error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Returns the paginated list of products associated with a specific voucher. All parameters are optional.\n\n`id_product` filters results to the specified product IDs. Pass the parameter multiple times to filter by several products (e.g. `?id_product=111&id_product=222`). When omitted, all products in the voucher are returned.\n\n`sort` orders results in the form `field:direction`, where `field` is one of `redemptions`, `acos`, `roas`, and `direction` is `asc` or `desc` (e.g. `?sort=redemptions:desc`).\n\n`offset` is the number of products to skip (default: 0).\n\n`limit` must be between 1 and 100 (default: 30). `offset` must be a multiple of `limit`.\n\n**Performance metrics in the response:**\n\n- `acos` — Advertising Cost of Sales, expressed as a percentage. Computed as `(voucher_fee_for_product / total_sales_for_product) * 100`. Lower values indicate a more cost-efficient voucher.\n- `roas` — Return on Ad Spend, expressed as a ratio. Computed as `total_sales_for_product / voucher_fee_for_product`. Higher values indicate a higher return per unit of voucher cost.\n\nBoth metrics are `0` when the product has not generated any sales through the voucher.","summary":"Get products for a voucher.","tags":["Vouchers"],"security":[],"parameters":[{"description":"The ID of the voucher.","in":"path","name":"id_voucher","required":true,"schema":{"format":"double","type":"number"}},{"description":"Number of products to skip. Must be a non-negative integer.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}},{"description":"Number of products to return per page. Must be between 1 and 100.","in":"query","name":"limit","required":false,"schema":{"default":30,"format":"int32","type":"integer","minimum":1,"maximum":100}},{"description":"Sort results in the form `field:direction`.","in":"query","name":"sort","required":false,"schema":{"type":"string"}},{"description":"Filter by one or more product IDs. When omitted, all products are included.","in":"query","name":"id_product","required":false,"schema":{"default":[],"type":"array","items":{"type":"string"}}}]}},"/shipping-labels":{"post":{"operationId":"CreateShippingLabel","responses":{"201":{"description":"Shipping label created","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":"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":"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"}}]}},"/similar-products/groups":{"get":{"operationId":"ListSimilarProductGroups","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_SimilarProductGroup_"},"examples":{"Example 1":{"value":{"data":[{"group_id":"a1b2c3","storefront":"de","currency":"EUR","group_demand":"high","own_price_rank":1,"own_sales_rank":1,"own_share":"high","gap_to_best_price":149,"number_of_competitors":4,"easy_win":true,"recommendation":"focus","ladder":[{"price_rank":1,"seller":"Example Seller GmbH","id_product":123456789,"product_name":"Example product","ean":"1234567890123","price":1999,"shipping_cost":299,"delivery_time_min":1,"delivery_time_max":3,"ratings_count":128,"average_rating":4.5,"manufacturer_name":"Example Manufacturer","voucher":{"discount_amount":10,"discount_type":"percent","discounted_price":1799},"is_excluded":false,"is_own_offer":false}]}],"pagination":{"offset":0,"limit":20,"total":4}}}}}}},"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":"Returns the authenticated seller's product similarity groups with their competitor ladders.","summary":"Get product similarity groups and their competitor ladders","tags":["Product Similarity Groups"],"security":[],"parameters":[{"description":"Storefront whose product similarity groups are returned.","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Number of groups to skip before returning the page.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer","minimum":0}},{"description":"Maximum number of groups to return.","in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","type":"integer","minimum":1,"maximum":50}}]}},"/similar-products/buybox":{"get":{"operationId":"GetSimilarProductsBuybox","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_OwnBrandOffersRankings-Array_"},"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","condition":"NEW","id_unit":28374940,"id_offer":"SKU1342"}]}]}}}}}},"400":{"description":"Request parameters are invalid, or neither id_product nor ean was provided.","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"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Kaufland groups your product with closely comparable products from other sellers. These are\nseparate products, not offers on the same product page, so there is no real Buy Box between\nthem. But shoppers who come across them in search treat them as interchangeable and usually\ntake the cheapest one, so in practice they compete like a Buy Box does. This endpoint ranks\nup to 10 products in that group the same way, so you get the whole picture in one call\ninstead of checking product by product.\n\nEach array entry describes the ranking for one product in the group: `id_product`, `storefront`,\n`condition`, `num_units` (total number of offers for that product and condition), and `units`\n(the ranked list of offers). Each unit has `buybox_rank` (1 is the winning offer), `seller`,\n`price` and `shipping_rate` (both in the minor currency unit), `delivery_time_min`/`_max` in\ndays, `fulfillment_type` (`fulfilled_by_merchant` or `fulfilled_by_kaufland`), `condition`, and,\nonly when you own the unit, `id_unit` and `id_offer`.","summary":"Get the Virtual Buy Box for up to 10 similar products","tags":["Virtual Buy Box On Similar Products"],"security":[],"parameters":[{"description":"The storefront you want the ranking for.","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Kaufland's product ID of one of your products. We return the group of similar\nproducts this product belongs to. Either id_product or ean is required.","in":"query","name":"id_product","required":false,"schema":{"format":"int64","type":"integer","minimum":1},"example":8475634},{"description":"The EAN of one of your products. Use it instead of id_product.\nEither id_product or ean is required.","in":"query","name":"ean","required":false,"schema":{"type":"string"},"example":"4006381333931"},{"description":"Which offer condition to return, same as GET /buybox.","in":"query","name":"condition","required":false,"schema":{"$ref":"#/components/schemas/BuyboxCondition"}}]}},"/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":"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 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":{"description":"Request body containing data for playground orders that shall be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createCollectionInput_UnitsDetails_","description":"Request body containing data for playground orders that shall be created"}}}}}},"/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","condition":"NEW","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 to return.<br>\n<code>used</code> and <code>refurbished</code> are <b>group</b> conditions: selecting one returns offers across\n<b>all</b> of its sub-conditions. Any other value (including <code>new</code>) returns only the offers matching\nthat <b>exact</b> condition.\n<ul>\n<li><code>used</code> returns offers in any of: <code>USED___AS_NEW</code>, <code>USED___VERY_GOOD</code>,\n<code>USED___GOOD</code>, <code>USED___ACCEPTABLE</code></li>\n<li><code>refurbished</code> returns offers in any of: <code>REFURBISHED___AS_NEW</code>,\n<code>REFURBISHED___VERY_GOOD</code>, <code>REFURBISHED___GOOD</code>, <code>REFURBISHED___ACCEPTABLE</code></li>\n<li><code>used - good</code> returns only offers with condition <code>USED___GOOD</code></li>\n</ul><br>","in":"query","name":"condition","required":true,"schema":{"$ref":"#/components/schemas/BuyboxCondition"}}]}},"/info/commission-rates/lookup":{"post":{"operationId":"LookupCommissionRates","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_CommissionRate_"},"examples":{"Example 1":{"value":{"data":[{"ean":"4006381333931","storefront":"de","status":"OK","commission_rate_estimate":{"variable_fee":7,"fixed_fee":0}},{"ean":"3607345809915","storefront":"de","status":"NO_COMMISSION_RATE"},{"ean":"0000000000000","storefront":"de","status":"NOT_FOUND"}]}}}}}},"400":{"description":"Bad request - the payload is invalid or contains more than the maximum of 50 products","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":"Looks up the current commission rate for up to 50 products, identified by\nEAN, within a single storefront.\n\nThe returned `commission_rate_estimate` reflects the commission rate\ncurrently configured for the product at the moment of the request. It is\nexposed as an *estimate* because the commission ultimately charged is\ndetermined at invoice time and may differ from the value returned here.\n\nEach result entry indicates the outcome via `status`:\n\n - `OK` - a rate is available; see `commission_rate_estimate`.\n - `NOT_FOUND` - no product could be located for the requested EAN\n   and storefront.\n - `NO_COMMISSION_RATE` - the product exists but no commission rate\n   is configured; `commission_rate_estimate` is omitted.","summary":"Look up commission rates for a list of products by EAN","tags":["Info"],"security":[],"parameters":[{"description":"Storefront the EANs are looked up in.","in":"query","name":"storefront","required":true,"schema":{"$ref":"#/components/schemas/Storefront"}}],"requestBody":{"description":"List of EANs (1-50) to look up commission rates for.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionRateLookupRequest","description":"List of EANs (1-50) to look up commission rates for."}}}}}},"/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":[{"description":"The ID of the import file to retrieve","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-addresses":{"get":{"operationId":"GetShippingAddresses","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionApiResponse_ShippingAddress_"}}}},"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"}}}},"422":{"description":"Request contains semantically invalid parameters","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 shipping addresses associated with the authenticated seller.\nResults can be filtered by order IDs or order unit IDs.","summary":"Get a list of shipping addresses","tags":["Shipping Addresses"],"security":[],"parameters":[{"description":"Locale of storefront","in":"query","name":"storefront","required":false,"schema":{"$ref":"#/components/schemas/Storefront"}},{"description":"Comma-separated list of order IDs to filter by<br>max: 100","in":"query","name":"order_ids","required":false,"schema":{"type":"string"},"example":"MB7UWLD,MXANBSH"},{"description":"Comma-separated list of order unit IDs to filter by<br>max: 100","in":"query","name":"order_unit_ids","required":false,"schema":{"type":"string"},"example":"12345,67890"},{"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}},{"description":"Sort order for results, e.g. <code>ts_created:desc</code>","in":"query","name":"sort","required":false,"schema":{"type":"string"}}]}},"/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":[{"description":"ID of the shipping group","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"}},{"description":"List of related resources to include in the response","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-09-24T10:45:52.591Z","date_lastchange_iso":"2026-09-24T10:45:52.591Z","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,"manufacturer_guarantee_years":2,"is_live":true}}}}}}},"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"}},{"description":"Comma-separated list of related resources to include in the response","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/status":{"post":{"operationId":"GetUnitsStatus","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiResponse_Array_UnitsStatusEntry-or-UnitsStatusNotFound__"},"examples":{"Example 1":{"value":{"data":[{"id_unit":1,"status_code":200,"is_live":false,"reasons":[{"reason":"stock_update_needed","reason_description":"The stock quantity is set to zero. Please update your stock to reactivate the offer."},{"reason":"divid_number_needed","reason_description":"This offer is subject to the Single-Use Plastics Fund Act. Please register on the EPR compliance page in the Seller Portal to activate this offer."}]},{"id_unit":2,"status_code":200,"is_live":true,"reasons":[]},{"id_unit":3,"status_code":200,"is_live":false,"reasons":[{"reason":"product_data_incomplete","reason_description":"Some product data is incomplete or needs review. Please review and update the product data.","details_url":"https://www.kauflandglobalmarketplace.com/en/seller-university/selling/product-data/general/"}]},{"id_unit":999,"status_code":404,"message":"Unit not found"}]}}}}}},"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"}}}},"503":{"description":"A downstream service was unavailable, so the not-live reasons could not be determined","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Get detailed status reasons for a set of units. For each unit, returns whether it is live\nand, if not, why.\n\n**Notes:**\n\n- New `reason` values may be added in future releases. This is a non-breaking change, so use `reason_description` as a human-readable fallback for any value you do not recognize. A reason that has no seller-facing identifier yet is reported as `unknown_reason`.\n- If the reasons for a unit that is not live cannot be determined, the whole request fails rather than returning an incomplete `reasons` list: `503` when the downstream service is unavailable or times out, `500` for any other downstream failure. Both are safe to retry.","summary":"Get live status details for a 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"}}],"requestBody":{"description":"Request body with the unit IDs to look up","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitsStatusRequest","description":"Request body with the unit IDs to look up"}}}}}},"/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"}},{"description":"Comma-separated list of related resources to include in the response","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"}},{"description":"Comma-separated list of related resources to include in the response","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"}}}},"400":{"description":"Request body exceeds 150 units","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":"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"}},{"description":"Comma-separated list of related resources to include in the response","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":"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":"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":{"description":"Subscription details to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscriptionRequest","description":"Subscription details to create"}}}}}},"/subscriptions/{id_subscription}":{"get":{"operationId":"GetSubscription","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":"Get a push notification subscription by <code>id_subscription</code>.","summary":"Get a push notification subscription by ID","tags":["Subscriptions"],"security":[],"parameters":[{"description":"Internal Id of Subscription, unique across all Subscriptions","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":[{"description":"Internal ID of Subscription, unique across all Subscriptions","in":"path","name":"id_subscription","required":true,"schema":{"$ref":"#/components/schemas/LongInteger"}}],"requestBody":{"description":"Fields of the subscription to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionRequest","description":"Fields of the subscription to update"}}}}},"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":[{"description":"Internal ID of Subscription, unique across all Subscriptions","in":"path","name":"id_subscription","required":true,"schema":{"$ref":"#/components/schemas/LongInteger"}}]}}},"servers":[{"url":"/v2"}],"tags":[{"name":"Assortment Insights"},{"name":"Buybox"},{"name":"GPSR Manufacturer Contacts"},{"name":"GPSR Product Contacts"},{"name":"Info"},{"name":"Order Units"},{"name":"Orders"},{"name":"Playground"},{"name":"Product Similarity Groups"},{"name":"Products"},{"name":"Return Units"},{"name":"Returns"},{"name":"Shipments"},{"name":"Shipping Addresses"},{"name":"Shipping Groups"},{"name":"Shipping Labels"},{"name":"Status"},{"name":"Subscriptions"},{"name":"Units"},{"name":"Variant Suggestion"},{"name":"Virtual Buy Box On Similar Products"},{"name":"Vouchers"},{"name":"Warehouses"}]}