### Get Delivery Settings Response Sample Source: https://developer.allegro.pl/documentation Example response when retrieving current delivery settings. Includes free delivery amounts, currency, and join policy. ```json { "marketplace": { "id": "allegro-pl" }, "freeDelivery": { "amount": "123.45", "currency": "PLN" }, "abroadFreeDelivery": { "amount": "900.12", "currency": "PLN" }, "joinPolicy": { "strategy": "MAX" }, "customCost": { "allowed": false }, "updatedAt": "2025-08-24T14:15:22Z" } ``` -------------------------------- ### Get Promotions List Response Sample Source: https://developer.allegro.pl/documentation Example JSON response for retrieving a list of promotions. It includes promotion details like benefits, creation date, ID, offer criteria, and status. ```json { "promotions": [ { "benefits": [ { "specification": { "type": "string" } } ], "createdAt": "2019-05-01T10:12:32.321Z", "id": "7c9a76d3-9fd0-4d13-a4ce-5d49bec12c79", "offerCriteria": [ { "offers": [ { "id": "1233432" } ], "type": "CONTAINS_OFFERS" } ], "status": "ACTIVE" } ], "totalCount": 0 } ``` -------------------------------- ### Response Sample for Get User Ratings Source: https://developer.allegro.pl/documentation Example JSON response for the 'get/sale/user-ratings' endpoint, illustrating the structure of rating data. ```json { "ratings": [ { "answer": { "createdAt": "2017-05-17T08:36:57.292Z", "message": "That is not our fault" }, "buyer": { "id": "string", "login": "string" }, "comment": "string", "createdAt": "2017-05-17T08:36:57.292Z", "editedAt": "2017-05-19T08:36:57.292Z", "excludedFromAverageRates": false, "excludedFromAverageRatesReason": "Rating not unique", "id": "string", "lastChangedAt": "2017-05-19T08:36:57.292Z", "order": { "id": "5354bed4-92b7-4fbb-9810-03a8f7834d15", "offers": [ { "id": "12323523523", "title": "Smart TV", "snapshot": "string" } ] }, "rates": { "delivery": 5, "deliveryCost": 5, "description": 5, "service": 5 }, "recommended": false, "removal": { "possibleTo": "2017-05-17T08:36:57.292Z", "request": { "createdAt": "2017-05-17T08:36:57.292Z", "message": "string", "source": "SELLER" } } } ] } ``` -------------------------------- ### Example API Endpoint Source: https://developer.allegro.pl/documentation The base URL for the Allegro API endpoint to retrieve sale products. ```text https://api.{environment}/sale/products ``` -------------------------------- ### Response Sample for Get Specific User Rating Source: https://developer.allegro.pl/documentation Example JSON response for the 'get/sale/user-ratings/{ratingId}' endpoint, showing the details of a specific rating. ```json { "answer": { "createdAt": "2017-05-17T08:36:57.292Z", "message": "That is not our fault" }, "buyer": { "id": "string", "login": "string" }, "comment": "string", "createdAt": "2017-05-17T08:36:57.292Z", "editedAt": "2017-05-19T08:36:57.292Z", "excludedFromAverageRates": false, "excludedFromAverageRatesReason": "Rating not unique", "id": "string", "lastChangedAt": "2017-05-19T08:36:57.292Z", "order": { "id": "5354bed4-92b7-4fbb-9810-03a8f7834d15", "offers": [ { "id": "12323523523", "title": "Smart TV", "snapshot": "string" } ] }, "rates": { "delivery": 5, "deliveryCost": 5, "description": 5, "service": 5 }, "recommended": false, "removal": { "possibleTo": "2017-05-17T08:36:57.292Z", "request": { "createdAt": "2017-05-17T08:36:57.292Z", "message": "string", "source": "SELLER" } } } ``` -------------------------------- ### Get list of compatible products Source: https://developer.allegro.pl/documentation Fetches compatible products of a given type. Requires user authorization. ```APIDOC ## Get list of compatible products Resource allows to fetch compatible products of given type. Read more: PL / EN. ##### Authorizations: _bearer-token-for-user_ ``` -------------------------------- ### Turnover Discount Request Payload Example Source: https://developer.allegro.pl/documentation This is an example of the request body schema for creating or modifying a turnover discount. It defines the discount thresholds based on minimum turnover amounts and the corresponding discount percentages. ```json { "thresholds": [ { "minimumTurnover": { "amount": "4000", "currency": "CZK" }, "discount": { "percentage": "5" } } ] } ``` -------------------------------- ### Get all data of the particular product-offer Source: https://developer.allegro.pl/documentation Use this resource to retrieve all data of a particular product-offer. This endpoint requires user authorization. ```APIDOC ## GET /sale/product-offers/{offerId} ### Description Retrieves all data associated with a specific product offer. This is useful for obtaining comprehensive details about a listed product. ### Method GET ### Endpoint https://api.{environment}/sale/product-offers/{offerId} ### Parameters #### Path Parameters - **offerId** (string) - Required - Offer identifier. #### Header Parameters - **Accept-Language** (string) - Optional - Expected language of messages. Enum: "en-US" "pl-PL" "uk-UA" "sk-SK" "cs-CZ" "hu-HU". Example: pl-PL ### Responses #### Success Response (200) Offer returned successfully. #### Error Responses - **400** - Invalid offer ID format - **401** - Unauthorized - **403** - Forbidden - **404** - Not Found ``` -------------------------------- ### Response Sample: Claim Details Source: https://developer.allegro.pl/documentation Example JSON response when retrieving details of a claim, including text, attachments, author, and creation timestamp. ```json { "id": "a9927fcc-f11a-436a-9f8d-177fd37d393c", "text": "Dzień dobry. Proszę o doprecyzowanie problemu.", "attachments": [ { "fileName": "example-image.jpg", "url": "https://api.allegro.pl/sale/issues/attachments/eeed0007-4404-4176-a1eb-11d26f056c0d" } ], "author": { "login": "example-seller", "role": "SELLER" }, "createdAt": "2025-06-10T12:12:12.019Z" } ``` -------------------------------- ### Response Sample for Get Size Table Source: https://developer.allegro.pl/documentation This JSON response contains details of a size table, including headers, ID, name, template, and values. ```json { "headers": [ { "name": "Sample header" } ], "id": "e02bc505-4311-11e8-b7fd-6c3be5b54a70", "name": "Nike shoes size table", "template": { "id": "5637592a-0a24-4771-b527-d89b2767d821" }, "values": [ { "cells": [ "30" ] } ] } ``` -------------------------------- ### Response Sample for a Created Promotion Source: https://developer.allegro.pl/documentation Example JSON response after successfully creating a promotion, showing its status, creation date, ID, and defined benefits. ```json { "status": "ACTIVE", "createdAt": "2019-05-01T10:02:31.123Z", "id": "72c40ffb-6127-4719-a473-867bf5775601", "benefits": [ { "specification": { "type": "LARGE_ORDER_DISCOUNT", "thresholds": [ { "orderValue": { "lowerBound": { "amount": "1000.00", "currency": "PLN" } }, "discount": { "percentage": "5" } }, { "orderValue": { "lowerBound": { "amount": "1500.00", "currency": "PLN" } }, "discount": { "percentage": "8" } } ] } } ], "offerCriteria": [ { "type": "ALL_OFFERS" } ] } ``` -------------------------------- ### Request Sample for Get Offer Promotion Packages Source: https://developer.allegro.pl/documentation This is a sample JSON response when retrieving promotion packages for an offer. It includes details about base and extra packages, as well as pending changes for the offer and any additional marketplaces. ```json { "marketplaceId": "allegro-pl", "basePackages": [ { "id": "emphasized1d", "name": "Flexible Feature", "cycleDuration": "PT24H" } ], "extraPackages": [ { "id": "emphasized1d", "name": "Flexible Feature", "cycleDuration": "PT24H" } ], "additionalMarketplaces": [ { "marketplaceId": "allegro-pl", "basePackages": [ { "id": "emphasized1d", "name": "Flexible Feature", "cycleDuration": "PT24H" } ], "extraPackages": [ { "id": "emphasized1d", "name": "Flexible Feature", "cycleDuration": "PT24H" } ] } ] } ``` -------------------------------- ### Response Sample for Get Offer Promotion Packages Source: https://developer.allegro.pl/documentation This is a sample JSON response when retrieving promotion packages for an offer. It includes details about base and extra packages, as well as pending changes for the offer and any additional marketplaces. ```json { "offerId": "9991337999", "marketplaceId": "allegro-pl", "basePackage": { "id": "emphasized1d", "validFrom": "2020-01-01T00:00:00Z", "validTo": "2020-01-01T00:00:00Z", "nextCycleDate": "2020-01-01T00:00:00Z" }, "extraPackages": [ { "id": "emphasized1d", "validFrom": "2020-01-01T00:00:00Z", "validTo": "2020-01-01T00:00:00Z", "nextCycleDate": "2020-01-01T00:00:00Z" } ], "pendingChanges": { "basePackage": { "id": "emphasized1d", "validFrom": "2020-01-01T00:00:00Z", "validTo": "2020-01-01T00:00:00Z", "nextCycleDate": "2020-01-01T00:00:00Z" } }, "additionalMarketplaces": [ { "marketplaceId": "allegro-pl", "basePackage": { "id": "emphasized1d", "validFrom": "2020-01-01T00:00:00Z", "validTo": "2020-01-01T00:00:00Z", "nextCycleDate": "2020-01-01T00:00:00Z" }, "extraPackages": [ { "id": "emphasized1d", "validFrom": "2020-01-01T00:00:00Z", "validTo": "2020-01-01T00:00:00Z", "nextCycleDate": "2020-01-01T00:00:00Z" } ], "pendingChanges": { "basePackage": { "id": "emphasized1d", "validFrom": "2020-01-01T00:00:00Z", "validTo": "2020-01-01T00:00:00Z", "nextCycleDate": "2020-01-01T00:00:00Z" } } } ] } ``` -------------------------------- ### Get Responsible Producers Response Sample Source: https://developer.allegro.pl/documentation Example of a successful response when retrieving a list of responsible producers. Includes producer details, count, and total count. ```json { "responsibleProducers": [ { "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5", "name": "Company responsible for producing product.", "producerData": { "tradeName": "Trade name of responsible producer", "address": { "countryCode": "PL", "street": "Wiśniowa 1", "postalCode": "00-000", "city": "Warszawa" }, "contact": { "email": "some@email.com", "phoneNumber": "123123123", "formUrl": "https://example.com/contact" } } } ], "count": 1, "totalCount": 1 } ``` -------------------------------- ### Example Response for Compatible Products (200 OK) Source: https://developer.allegro.pl/documentation This JSON structure represents a successful response when retrieving compatible products. It includes a list of products, each with its ID, text description, group information, and a detailed list of attributes. ```json { "compatibleProducts": [ { "id": "fc1058e6-a901-4b58-be4d-3d7e1368f63e", "text": "AUDI A6 (4G2, 4GC, C7) 2014/09-2018/09 3.0 TDI quattro 326KM/240kW", "group": { "id": "19d71c872aa6c78663876a7e7bc7776d" }, "attributes": [ { "id": "POWER_KW", "values": [ "240" ] }, { "id": "MODEL_FROM", "values": [ "2010/11" ] }, { "id": "BRAND", "values": [ "AUDI" ] }, { "id": "POWER_HP", "values": [ "326" ] }, { "id": "MODEL_TO", "values": [ "2018/09" ] }, { "id": "ENGINE_CODE", "values": [ "CVUB" ] }, { "id": "K_TYP_NR", "values": [ "108441" ] }, { "id": "VERSION_FROM", "values": [ "2014/09" ] }, { "id": "VERSION_TO", "values": [ "2018/09" ] }, { "id": "MODEL", "values": [ "A6 (4G2, 4GC, C7)" ] }, { "id": "BODY", "values": [ "sedan" ] }, { "id": "TYPE", "values": [ "3.0 TDI quattro" ] } ] } ], "count": 1, "totalCount": 1448 } ``` -------------------------------- ### Get order events statistics Source: https://developer.allegro.pl/documentation Retrieves an object containing the latest event ID and its occurrence date. This provides a starting point for fetching subsequent events. ```APIDOC ## Get order events statistics Use this resource to returns object that contains event id and occurrence date of the latest event. It gives you current starting point for reading events. ### Method GET ### Endpoint /order/event-stats ### Headers - **Accept-Language** (string) - Example: pl-PL - Expected language of messages. ### Responses #### Success Response (200) OK #### Response Example ```json { "latestEvent": { "id": "1532603898317497", "occurredAt": "2018-10-12T10:12:32.321Z" } } ``` ``` -------------------------------- ### Get Delivery Methods Source: https://developer.allegro.pl/documentation Use this resource to get a list of all delivery methods currently available on the platform, as well as those that have already been discontinued. ```APIDOC ## GET /sale/delivery-methods ### Description Use this resource to get a list of all delivery methods currently available on the platform, as well as those that have already been discontinued. ### Method GET ### Endpoint https://api.{environment}/sale/delivery-methods ### Parameters #### Query Parameters - **marketplace** (string) - Example: marketplace=allegro-pl - Allows to filter delivery methods by marketplace id. #### Header Parameters - **Accept-Language** (string) - Enum: "en-US" "pl-PL" "uk-UA" "sk-SK" "cs-CZ" "hu-HU" - Example: pl-PL - Expected language of messages. ### Responses #### Success Response (200) OK #### Error Responses - **401** - Authentication required. ``` -------------------------------- ### Response Sample for Bundle Creation Source: https://developer.allegro.pl/documentation This is a sample JSON response for creating or retrieving bundle information. It includes details about offers, publication status, discounts, and creation metadata. ```json { "id": "a42d09c2-2669-4e7c-989b-7c341e84f787", "offers": [ { "id": "123456789", "requiredQuantity": 1, "entryPoint": true }, { "id": "987654321", "requiredQuantity": 2, "entryPoint": false } ], "publication": [ { "marketplace": { "id": "allegro-pl" }, "status": "ACTIVE" } ], "discounts": [ { "marketplace": { "id": "allegro-pl" }, "amount": "10.15", "currency": "PLN" } ], "createdAt": "2023-09-21T10:22:02.999Z", "createdBy": "USER" } ``` -------------------------------- ### Get the user's delivery settings Source: https://developer.allegro.pl/documentation Use this resource to get the delivery settings declared by the seller. It accepts query parameters to filter by marketplace ID. ```APIDOC ## GET /delivery-settings ### Description Use this resource to get the delivery settings declared by the seller. ### Method GET ### Endpoint `https://api.{environment}/delivery-settings` ### Parameters #### Query Parameters - **marketplace.id** (string) - Optional - Marketplace for which delivery settings will be returned. Example: marketplace.id=allegro-pl ``` -------------------------------- ### Example Dynamic Filter Query Source: https://developer.allegro.pl/documentation Demonstrates how to apply dynamic filters for product attributes like 'Kolor' (Color). The filter ID and its corresponding value are used in the query. ```text 127448=127448_2 ``` ```text 127448=127448_1 ``` -------------------------------- ### Full Offer Payload Example Source: https://developer.allegro.pl/documentation This snippet shows a comprehensive JSON payload for creating or updating an offer on Allegro. It includes details about the product, pricing, delivery, images, and various other attributes. ```json { "productSet": [ { "product": { "name": "iPhone 5s", "category": { "id": "257931" }, "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4", "idType": "GTIN", "parameters": [ { "id": "224017", "name": "Manufacturer code", "rangeValue": { "from": "20", "to": "80" }, "values": [ "4234" ], "valuesIds": [ "129970_850936" ] } ], "images": [ "https://a.allegroimg.com/original/12068b/359d04074521b79df1b2807a6727" ] }, "quantity": { "value": 1 }, "responsiblePerson": { "id": "33960380-98fe-4b3d-b69e-b261526f2730", "name": "Responsible company" }, "responsibleProducer": { "type": "ID", "id": "12345678-9abc-def1-2345-6789abcdef12" }, "safetyInformation": { "type": "TEXT", "description": "string" }, "marketedBeforeGPSRObligation": false, "deposits": [ { "id": "5e8a9e73-7e55-4896-bd8a-9c430413e808", "quantity": 1 } ] } ], "b2b": { "buyableOnlyByBusiness": false }, "attachments": [ { "id": "07ee5e36-afc7-41eb-af49-3df5354ef85" } ], "fundraisingCampaign": { "id": "e2307b4f-6903-4be6-85e6-19e8ea303760", "name": "We are collecting food for animals from the shelter" }, "additionalServices": { "id": "string", "name": "string" }, "stock": { "available": 99, "unit": "UNIT" }, "delivery": { "handlingTime": "PT24H", "shippingRates": null, "additionalInfo": "Example additional info", "shipmentDate": "2019-08-24T14:15:22Z" }, "publication": { "duration": "PT24H", "startingAt": "2031-01-04T11:01:59Z", "status": "INACTIVE", "republish": false, "endingAt": "2031-01-04T11:01:59Z" }, "additionalMarketplaces": { "allegro-cz": { "sellingMode": { "price": { "amount": "233", "currency": "CZK" } } }, "compatibilityList": { "type": "MANUAL", "items": [ { "type": "TEXT", "text": "CITROËN C6 (TD_) 2005/09-2011/12 2.7 HDi 204KM/150kW" } ] }, "language": "pl-PL", "category": { "id": "257931" }, "name": "Test offer name", "parameters": [ { "id": "224017", "name": "Manufacturer code", "rangeValue": { "from": "20", "to": "80" }, "values": [ "4234" ], "valuesIds": [ "129970_850936" ] } ], "afterSalesServices": { "impliedWarranty": { "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59", "name": "Implied warranty 1" }, "returnPolicy": { "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59", "name": "Return policy 1" }, "warranty": { "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59", "name": "Warranty 1" } }, "sizeTable": { "id": "string", "name": "Nike shoes size table" }, "contact": { "id": "11a2df7f-8237-4625-baa2-cb7541f39946", "name": "Piotr" }, "discounts": { "wholesalePriceList": { "id": "5637592a-0a24-4771-b527-d89b2767d821", "name": "Wholesale example" } }, "payments": { "invoice": "VAT" }, "sellingMode": { "format": "BUY_NOW", "price": { "amount": "123.45", "currency": "PLN" }, "minimalPrice": { "amount": "123.45", "currency": "PLN" }, "startingPrice": { "amount": "123.45", "currency": "PLN" } }, "location": { "city": "Poznań", "countryCode": "PL", "postCode": "00-999", "province": "WIELKOPOLSKIE" }, "images": "[\"https://a.allegroimg.com/original/12068b/359d04074521b79df1b2807a6727\"]", "description": { "sections": [ { "items": [ { "type": "string" } ] } ] }, "external": { "id": "AH-129834" }, "taxSettings": { "rates": [ { "rate": "23.00", "countryCode": "PL" } ], "subject": "GOODS", "exemption": "MONEY_EQUIVALENT" }, "messageToSellerSettings": { "mode": "OPTIONAL", "hint": "Choose size" } } ``` -------------------------------- ### Get an attachment Source: https://developer.allegro.pl/documentation Retrieves an attachment using its identifier. ```APIDOC ## GET /sale/issues/attachments/{attachmentId} ### Description Use this resource to get an attachment. ### Method GET ### Endpoint https://api.{environment}/sale/issues/attachments/{attachmentId} ### Parameters #### Path Parameters - **attachmentId** (string) - Required - Attachment identifier. #### Header Parameters - **Accept-Language** (string) - Optional - Enum: "en-US" "pl-PL" "uk-UA" "sk-SK" "cs-CZ" "hu-HU" - Expected language of messages. ### Response #### Success Response (200) OK #### Error Responses - **401**: Unauthorized - **403**: Forbidden - **404**: Not Found ``` -------------------------------- ### Response Sample: Additional Services Definitions by Categories Source: https://developer.allegro.pl/documentation This JSON sample shows the response structure for retrieving additional services definitions, categorized for easier management. It details categories like 'Installation/assembly services' and their associated services. ```json { "categories": [ { "name": "Installation/assembly services", "definitions": [ { "id": "CARRY_IN", "name": "Home delivery", "description": { "hint": "Describe how you gonna pack product as a gift, what paper you use etc.", "editable": true, "default": "Home delivery and installation/assembly of refrigerator, changing door opening direction, disassembly of used equipment, collection of used equipment." }, "maxPrice": { "amount": "123.45", "currency": "PLN" }, "availableConstraints": [ { "type": "string", "availableDeliveryMethods": [ "string" ] } ], "updatedAt": "2019-08-24T14:15:22Z" } ] } ] } ``` -------------------------------- ### Get a list of available badge campaigns Source: https://developer.allegro.pl/documentation Badge campaigns are another way to promote your offers. You can apply for a badge, which - depending on a type - will be displayed on your offer page of on the list of offers. First - use this resource to get a list of all available badge campaigns at the moment, then use _POST /sale/badges_ to apply for badge. ```APIDOC # Badge campaigns ## Get a list of available badge campaigns Badge campaigns are another way to promote your offers. You can apply for a badge, which - depending on a type - will be displayed on your offer page of on the list of offers. First - use this resource to get a list of all available badge campaigns at the moment, then use _POST /sale/badges_ to apply for badge. Read more: PL / EN. ##### Authorizations: _bearer-token-for-user_ ##### query Parameters marketplace.id| string Example: marketplace.id=allegro-plThe marketplace of campaigns. ---|--- ##### header Parameters Accept-Language| string Enum: "en-US" "pl-PL" "uk-UA" "sk-SK" "cs-CZ" "hu-HU" Example: en-USExpected language of messages. ---|--- ### Responses **200 ** List of available badge campaigns. **400 ** Invalid values supplied in the query parameters. **401 ** Unauthorized. **403 ** The account is not a Business Account. get/sale/badge-campaigns https://api.{environment}/sale/badge-campaigns ``` -------------------------------- ### Get Bundle by ID Source: https://developer.allegro.pl/documentation Retrieves a specific offer bundle using its unique identifier. ```APIDOC ## GET /sale/bundles/{bundleId} ### Description Retrieves a specific offer bundle using its unique identifier. ### Method GET ### Endpoint https://api.{environment}/sale/bundles/{bundleId} ### Parameters #### Path Parameters - **bundleId** (string) - Required - The unique identifier of the bundle to retrieve. #### Header Parameters - **Accept-Language** (string) - Optional - Expected language of messages (e.g., 'en-US', 'pl-PL'). ### Response #### Success Response (200) - **id** (string) - Unique identifier for the bundle. - **offers** (array) - List of offers included in the bundle. - **publication** (array) - Publication status on marketplaces. - **discounts** (array) - Discounts applied to the bundle. - **createdAt** (string) - Timestamp when the bundle was created. - **createdBy** (string) - User who created the bundle. #### Response Example ```json { "id": "a42d09c2-2669-4e7c-989b-7c341e84f787", "offers": [ { "id": "123456789", "requiredQuantity": 1, "entryPoint": true }, { "id": "987654321", "requiredQuantity": 2, "entryPoint": false } ], "publication": [ { "marketplace": { "id": "allegro-pl" }, "status": "ACTIVE" } ], "discounts": [ { "marketplace": { "id": "allegro-pl" }, "amount": "10.15", "currency": "PLN" } ], "createdAt": "2023-09-21T10:22:02.999Z", "createdBy": "USER" } ``` ``` -------------------------------- ### Get suggested compatibility list Source: https://developer.allegro.pl/documentation Fetches a compatibility list suggestion for a given offer or product. Supports language negotiation via the Accept-Language header. ```APIDOC ## Get suggested compatibility list. Resource allows to fetch compatibility list suggestion for given offer or product. Read more: PL / EN. ##### Authorizations: _bearer-token-for-user_ ##### query Parameters offer.id| string Offer id on the basis of which we will return the suggested compatibility list. product.id| string Product id on the basis of which we will return the suggested compatibility list. language| string Example: language=pl-PLLocale on the basis of which we will return the suggested compatibility list. For product-based suggestions if missing pl-PL will be used. For offer-based suggestions if missing offer language will be used. ##### header Parameters Accept-Language| string Enum: "en-US" "pl-PL" "uk-UA" "sk-SK" "cs-CZ" "hu-HU" Example: en-USExpected language of messages. ### Responses **200 ** Compatibility list suggestion returned successfully. **400 ** Bad request. **401 ** Unauthorized. **404 ** Suggestion was not found. get/sale/compatibility-list-suggestions https://api.{environment}/sale/compatibility-list-suggestions ### Response samples * 200 * 400 * 401 * 404 Content type application/vnd.allegro.public.v1+json Example MANUALPRODUCT_BASEDMANUAL Copy Expand all Collapse all `{ * "type": "MANUAL", * "items": [ * { * "type": "TEXT", * "text": "CITROËN C6 (TD_) 2005/09-2011/12 2.7 HDi 204KM/150kW" } ] }` ``` -------------------------------- ### Get Responsible Producer by ID Source: https://developer.allegro.pl/documentation Retrieves a specific responsible producer by its ID for product compliance. ```APIDOC ## GET /sale/responsible-producers/{id} ### Description Retrieves a specific responsible producer by its ID for product compliance. ### Method GET ### Endpoint https://api.{environment}/sale/responsible-producers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Responsible producer ID. Must be a valid UUID. #### Header Parameters - **Accept** (string) - Required - Example: application/vnd.allegro.public.v1+json. Acceptable representation of the response. - **Accept-Language** (string) - Optional - BCP-47 language code. Enum: "en-US", "pl-PL", "uk-UA", "sk-SK", "cs-CZ", "hu-HU". Example: pl-PL. Expected language of messages. ### Response #### Success Response (200) OK #### Response Example (Response structure is the same as for GET /sale/responsible-producers, but for a single producer) ```json { "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5", "name": "Company responsible for producing product.", "producerData": { "tradeName": "Trade name of responsible producer", "address": { "countryCode": "PL", "street": "Wiśniowa 1", "postalCode": "00-000", "city": "Warszawa" }, "contact": { "email": "some@email.com", "phoneNumber": "123123123", "formUrl": "https://example.com/contact" } } } ``` ``` -------------------------------- ### Successful Offer Creation Response (200 OK) Source: https://developer.allegro.pl/documentation This is a sample JSON response for a successful offer creation. It includes detailed information about the product, its parameters, publication status, delivery options, and validation results. ```json { "productSet": [ { "quantity": { "value": 1 }, "product": { "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4", "publication": { "status": "LISTED" }, "parameters": [ { "id": "224017", "name": "Manufacturer code", "rangeValue": { "from": "20", "to": "80" }, "values": [ "4234" ], "valuesIds": [ "129970_850936" ] } ], "isAiCoCreated": false }, "responsiblePerson": { "id": "570c928f-39ac-4838-93bb-eb829bc2136f" }, "responsibleProducer": { "id": "33960380-98fe-4b3d-b69e-b261526f2730" }, "safetyInformation": { "type": "TEXT", "description": "Contains small parts" }, "marketedBeforeGPSRObligation": false, "deposits": [ { "id": "5e8a9e73-7e55-4896-bd8a-9c430413e808", "quantity": 1 } ] } ], "id": "12394584234", "name": "Test offer name", "category": { "id": "257931" }, "attachments": [ { "id": "07ee5e36-afc7-41eb-af49-3df5354ef85" } ], "fundraisingCampaign": { "id": "string" }, "additionalServices": { "id": "string" }, "delivery": { "handlingTime": "PT24H", "shippingRates": { "id": "5637592a-0a24-4771-b527-d89b2767d821" }, "additionalInfo": "Example additional info", "shipmentDate": "2019-08-24T14:15:22Z" }, "publication": { "duration": "PT24H", "startingAt": "2031-01-04T11:01:59Z", "status": "INACTIVE", "republish": false, "endingAt": "2031-01-04T11:01:59Z", "endedBy": "USER", "marketplaces": { "base": { "id": "5637592a-0a24-4771-b527-d89b2767d821" }, "additional": [ { "id": "5637592a-0a24-4771-b527-d89b2767d821" } ] } }, "additionalMarketplaces": { "allegro-cz": { "sellingMode": { "price": { "amount": "233", "currency": "CZK" } }, "publication": { "state": "REFUSED", "refusalReasons": [ { "code": "VQR009_PRICE_IN_ADDITIONAL_MARKETPLACE_MISMATCH", "userMessage": "price difference too big", "parameters": { "maxAllowedPriceDecreasePercent": [ "20" ] } } ] } } }, "b2b": { "buyableOnlyByBusiness": false }, "compatibilityList": { "type": "MANUAL", "items": [ { "type": "TEXT", "text": "CITROËN C6 (TD_) 2005/09-2011/12 2.7 HDi 204KM/150kW" } ] }, "language": "pl-PL", "validation": { "errors": [ { "code": "NotAcceptableException", "details": null, "message": "An error has occurred", "path": "category.id", "userMessage": "Request contains invalid data. Contact the application author.", "metadata": { "productId": "13232515" } } ], "warnings": [ { "code": "UnknownJSONProperty", "details": "Unknown properties found in the request.", "message": "Unknown properties found in the request.", "path": "endedBy", "userMessage": "Unknown parameters found in the query.", "metadata": { "productId": "13232515" } } ], "validatedAt": "2019-08-24T14:15:22Z" }, "warnings": [ ], "afterSalesServices": { "impliedWarranty": { "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59" }, "returnPolicy": { "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59" }, "warranty": { "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59" } }, "discounts": { "wholesalePriceList": { "id": "5637592a-0a24-4771-b527-d89b2767d821" } }, "stock": { "available": 99, "unit": "UNIT" }, "parameters": [ { "id": "224017", "name": "Manufacturer code", "rangeValue": { "from": "20", "to": "80" }, "values": [ "4234" ], "valuesIds": [ "129970_850936" ] } ], "contact": { "id": "11a2df7f-8237-4625-baa2-cb7541f39946" }, "createdAt": "2019-05-29T12:00:00Z", "updatedAt": "2019-05-29T12:00:00Z", "payments": { "invoice": "VAT" }, "sellingMode": { "format": "BUY_NOW", "price": { "amount": "123.45", "currency": "PLN" }, "minimalPrice": { "amount": "123.45", "currency": "PLN" }, "startingPrice": { "amount": "123.45", "currency": "PLN" } }, "location": { "city": "Poznań", "countryCode": "PL", "postCode": "00-999" } } ``` -------------------------------- ### Retrieve Turnover Discounts for Marketplaces Source: https://developer.allegro.pl/documentation Use this endpoint to get a list of turnover discounts for specified marketplaces. Currently, only 'allegro-business-cz' is supported. The response includes discounts with statuses like ACTIVATING, ACTIVE, or DEACTIVATING. ```bash curl -X GET \ -H "Authorization: Bearer " \ -H "Accept-Language: pl-PL" \ https://api.allegro.pl/sale/turnover-discount?marketplaceId=allegro-business-cz ```