Allegro REST API (latest)
https://developer.allegro.pl/about
Documentation is generated from this OpenAPI 3.0 specification file.
bearer-token-for-user
For more information, see https://developer.allegro.pl/auth/#app to read about authorization code flow or https://developer.allegro.pl/auth/#DeviceFlow to read about the device code flow.
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://allegro.pl/auth/oauth/authorize Token URL: https://allegro.pl/auth/oauth/token Scopes: |
x-deviceCode OAuth Flow | Scopes: |
bearer-token-for-application
For more information, see https://developer.allegro.pl/auth/#clientCredentialsFlow
Security Scheme Type | OAuth2 |
---|---|
clientCredentials OAuth Flow | Token URL: https://allegro.pl/auth/oauth/token Scopes: |
Get seller's offers
Authorizations:
allegro:api:sale:offers:read
) query Parameters
offer.id | string Offer ID. |
name | string The text to search in the offer title. |
sellingMode.price.amount.gte | number >= 0 Example: sellingMode.price.amount.gte=9.99 The lower threshold of price. |
sellingMode.price.amount.lte | number >= 1 Example: sellingMode.price.amount.lte=125.99 The upper threshold of price. |
publication.status | Array of strings Items Enum: "INACTIVE" "ACTIVE" "ACTIVATING" "ENDED" The publication status of the offer. Passing more than one value will search for offers with any of the given statuses. By default all statuses are included. Example: |
sellingMode.format | Array of strings Items Enum: "BUY_NOW" "ADVERTISEMENT" "AUCTION" The offer's selling format. Passing more than one value will search for offers with any of the given formats. By default all formats are included. Example: |
external.id | Array of strings <= 100 items [ items <= 100 characters ] The ID from the client's external system. Passing more than one value will search for offers with any of the given IDs. By default no ID is included. Example: |
delivery.shippingRates.id | string <uuid> The ID of shipping rates. Returns offers with given shipping rates ID. |
delivery.shippingRates.id.empty | boolean Allow to filter offers by existence of shipping rates ID. |
sort | string Enum: "sellingMode.price.amount" "-sellingMode.price.amount" "stock.sold" "-stock.sold" "stock.available" "-stock.available" The results' sorting order. No prefix in the value means ascending order. |
limit | integer <int32> [ 1 .. 1000 ] Default: 20 The maximum number of offers returned in the response. |
offset | integer <int32> [ 0 .. 9999999 ] Index of the first returned offer from all search results. Maximum sum of offset and limit is 10 000 000. |
category.id | string The identifier of the category, where you want to search for offers. |
product.id.empty | boolean Allow to filter offers by existence of product ID. |
productizationRequired | boolean Allow to filter offers from categories where productization is required. |
b2b.buyableOnlyByBusiness | boolean Allow to filter business offers. |
Responses
Response samples
- 200
- 400
- 403
{- "offers": [
- {
- "id": "2865624934",
- "name": "Buty damskie adidas",
- "category": {
- "id": "257929"
}, - "sellingMode": {
- "format": "BUY_NOW",
- "price": {
- "amount": "123.45",
- "currency": "PLN"
}, - "minimalPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "startingPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "saleInfo": {
- "currentPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "biddersCount": 4
}, - "stock": {
- "available": 23,
- "sold": 3
}, - "stats": {
- "watchersCount": 99,
- "visitsCount": 0
}, - "publication": {
- "status": "INACTIVE",
- "startingAt": "2019-05-29T12:00:00Z",
- "startedAt": "2019-05-29T12:00:00Z",
- "endingAt": "2019-06-30T12:00:00Z",
- "endedAt": "2019-06-30T12:10:00Z"
}, - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}
}, - "additionalServices": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "external": {
- "id": "AH-129834"
}, - "delivery": {
- "shippingRates": {
- "id": "string"
}
}, - "b2b": {
- "buyableOnlyByBusiness": true
}
}
], - "count": 1,
- "totalCount": 1234
}
Get all fields of the particular offer
Authorizations:
allegro:api:sale:offers:read
) path Parameters
offerId required | string Offer identifier. |
Responses
Response samples
- 200
{- "additionalServices": {
- "id": "string"
}, - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}
}, - "attachments": [
- {
- "id": "1928302_MANUAL_45d7a0f543e1b0d05e12a1aef5642efe63389a1d419fe9286d0f158044391fdce"
}
], - "category": {
- "id": "257931"
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "contact": {
- "id": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "customParameters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "delivery": {
- "additionalInfo": "string",
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "shipmentDate": "2018-04-01T08:00:00Z"
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string"
}
}, - "external": {
- "id": "AH-129834"
}, - "fundraisingCampaign": {
- "id": "string"
}, - "id": "string",
- "images": [
- {
- "url": "string"
}
], - "location": {
- "city": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "name": "string",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "payments": {
- "invoice": "VAT"
}, - "product": {
- "id": "string"
}, - "promotion": {
- "bold": true,
- "departmentPage": true,
- "emphasized": true,
- "emphasizedHighlightBoldPackage": true,
- "highlight": true
}, - "publication": {
- "duration": "PT24H",
- "endingAt": "2031-01-04T11:01:59Z",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "endedBy": "USER",
- "republish": false
}, - "sellingMode": {
- "format": "BUY_NOW",
- "price": {
- "amount": "123.45",
- "currency": "PLN"
}, - "minimalPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "startingPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "netPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "sizeTable": {
- "id": "string"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}, - "updatedAt": "2019-08-24T14:15:22Z",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "language": "pl-PL"
}
Get Smart! classification report of the particular offer
Authorizations:
allegro:api:sale:offers:read
) path Parameters
offerId required | string Offer identifier. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "classification": {
- "fulfilled": true,
- "lastChanged": "2017-05-17T08:36:57.292+02:00"
}, - "scheduledForReclassification": true,
- "smartDeliveryMethods": [
- {
- "id": "2488f7b7-5d1c-4d65-b85c-4cbcf253fd93"
}, - {
- "id": "c3066682-97a3-42fe-9eb5-3beeccab840c"
}
], - "conditions": [
- {
- "code": "deliveryMethodPrices",
- "name": "Zgodność z cennikiem",
- "description": "Wymagamy aby metody dostawy były zgodne z cennikiem.",
- "fulfilled": true,
- "passedDeliveryMethods": [
- {
- "id": "2488f7b7-5d1c-4d65-b85c-4cbcf253fd93"
}, - {
- "id": "c3066682-97a3-42fe-9eb5-3beeccab840c"
}, - {
- "id": "259b5c7a-9056-4c74-80ec-8bdc50cb0413"
}, - {
- "id": "08e2ef8e-90c8-49db-8970-d6c2773f1530"
}
], - "failedDeliveryMethods": [
- {
- "id": "b20ef9e1-faa2-4f25-9032-adbea23e5cb9"
}, - {
- "id": "9081532b-5ad3-467d-80bc-9252982e9dd8"
}, - {
- "id": "98f86f81-0018-41c5-ac83-073a56fc7021"
}, - {
- "id": "5d9c7838-e05f-4dec-afdd-58e884170ba7"
}
]
}, - {
- "code": "returnPaidBy",
- "name": "Koszty zwrotu",
- "description": "Oferta musi mieć politykę zwrotu. Zagraniczne metody dostawy są zaklasyfikowane tylko jeśli koszt zwrotu jest pokryty przez sprzedającego.",
- "fulfilled": true,
- "passedDeliveryMethods": [
- {
- "id": "2488f7b7-5d1c-4d65-b85c-4cbcf253fd93"
}, - {
- "id": "c3066682-97a3-42fe-9eb5-3beeccab840c"
}
], - "failedDeliveryMethods": [
- {
- "id": "259b5c7a-9056-4c74-80ec-8bdc50cb0413"
}, - {
- "id": "08e2ef8e-90c8-49db-8970-d6c2773f1530"
}
]
}
]
}
Get events about the seller's offers
Use this endpoint to get events concerning changes in the authorized seller's offers. At present we support the following events:
- OFFER_ACTIVATED - offer is visible on site and available for purchase, occurs when offer status changes from ACTIVATING to ACTIVE.
- OFFER_CHANGED - occurs when offer's fields has been changed e.g. description or photos.
- OFFER_ENDED - offer is no longer available for purchase, occurs when offer status changes from ACTIVE to ENDED.
- OFFER_STOCK_CHANGED - stock in an offer was changed either via purchase or by seller.
- OFFER_PRICE_CHANGED - occurs when price in an offer was changed.
- OFFER_ARCHIVED - offer is no longer available on listing and has been archived.
- OFFER_BID_PLACED - bid was placed on the offer
- OFFER_BID_CANCELED - bid for offer was canceled
- OFFER_TRANSLATION_UPDATED - translation of offer was updated
Returned events may occur by actions made via browser or API. The resource allows you to get events concerning active offers and offers scheduled for activation (status ACTIVE and ACTIVATING). Returned events do not concern offers in INACTIVE and ENDED status (the exception is OFFER_ARCHIVED event). External id is returned for all event types except OFFER_BID_PLACED and OFFER_BID_CANCELED. Please note that one change may result in more than one event. Read more: PL / EN.
Authorizations:
allegro:api:sale:offers:read
) query Parameters
from | string <= 256 characters Example: from=MTEzMjQzODU3NA The ID of the last seen event. Events that occured after the given event will be returned. |
limit | integer [ 1 .. 1000 ] Default: 100 The number of events that will be returned in the response. |
type | Array of strings Items Enum: "OFFER_ACTIVATED" "OFFER_CHANGED" "OFFER_ENDED" "OFFER_STOCK_CHANGED" "OFFER_PRICE_CHANGED" "OFFER_ARCHIVED" "OFFER_BID_PLACED" "OFFER_BID_CANCELED" "OFFER_TRANSLATION_UPDATED" The types of events that will be returned in the response. All types of events are returned by default. |
Responses
Response samples
- 200
- 400
- 401
{- "id": "MTEzMjQzODU3NA",
- "occurredAt": "2019-06-26T15:26:43.891Z",
- "type": "OFFER_ACTIVATED",
- "offer": {
- "id": "2865624934",
- "external": {
- "id": "externalId"
}
}
}
Modify the Buy Now price in an offer
Authorizations:
allegro:api:sale:offers:write
) path Parameters
offerId required | string The offer identifier. |
commandId required | string <uuid> The unique command id generated by you. |
Request Body schema: application/vnd.allegro.public.v1+json
id | string <uuid> The unique command id generated by you. This should be the same UUID as used in the path. |
required | object (ChangePriceInput) The input of the command, i.e. the new Buy Now price for the offer. |
Responses
Request samples
- Payload
{- "id": "6365996a-6cae-11e9-a923-1681be663d3e",
- "input": {
- "buyNowPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}
}
Response samples
- 200
- default
{- "id": "6365996a-6cae-11e9-a923-1681be663d3e",
- "input": {
- "buyNowPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "output": {
- "status": "QUEUEING",
- "errors": [
- {
- "code": "NotAcceptableException",
- "details": null,
- "message": "Not acceptable representation requested. Please check 'Accept' request header",
- "path": null,
- "userMessage": "The request contains incorrect data. Contact the author of the application."
}
]
}
}
Create a draft offer
Authorizations:
allegro:api:sale:offers:write
) Request Body schema: application/vnd.allegro.public.v1+json
offer
object (JustId) | |
object (AfterSalesServices) The definitions of the different after sales services assigned to the offer. | |
Array of objects (Attachment) [ items ] List of offer attachments. You can attach up to 7 files to the offer – one per each attachment type as described in uploading offer attachments flow. | |
object Category in which the offer is listed for sale | |
object (CompatibilityList) | |
object (JustId) | |
createdAt | string <date-time> Creation date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ. Cannot be modified. |
Array of objects (CustomParameter) [ items ] List of custom parameters. You can add up to 4 custom parameters, each containing exactly one value. | |
object (DeliveryFull) | |
object (StandardizedDescription) The description section cannot have more than 40000 bytes in length. | |
object (Discounts) | |
object (ExternalId) The information on the offer in an external system. | |
object (JustId) | |
id | string |
Array of objects (ImageUrl) [ items ] | |
object (Location) for offer with a delivery method it is a parcel dispatch location. For offers with personal pick-up it is a pick-up location, additionally we recommend to use points of service (https://developer.allegro.pl/documentation/#tag/Points-of-service) | |
name required | string <= 50 characters Name of the offer. Words used in the name field cannot be longer than 50 characters. |
Array of objects (Parameter) [ items ] | |
object (Payments) | |
object (JustId) | |
object (Promotion) | |
object (Publication) | |
object (SellingModeWithNetPrice) Information on the offer's selling mode. | |
object (ExtendedTax) VAT tax settings. Available settings can be found under "get all tax settings for category" resource. | |
object (JustId) | |
object (Stock) | |
object (TecdocSpecification) Contains additional information describing products from automotive categories. Technical specification is created based on TecDoc database and can only be used while creating offer with assigned product to it. Read more. | |
object (B2b) Defines offer properties for buyers with company account (Allegro Biznes). | |
object (MessageToSellerSettings) Defines message to the seller settings options. | |
updatedAt | string <date-time> Last update date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ. Cannot be modified |
object (Validation) | |
language | string <BCP-47 language code> Declared base language of the offer. |
Responses
Request samples
- Payload
{- "additionalServices": {
- "id": "string"
}, - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}
}, - "attachments": [
- {
- "id": "1928302_MANUAL_45d7a0f543e1b0d05e12a1aef5642efe63389a1d419fe9286d0f158044391fdce"
}
], - "category": {
- "id": "257931"
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "contact": {
- "id": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "customParameters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "delivery": {
- "additionalInfo": "string",
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "shipmentDate": "2018-04-01T08:00:00Z"
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string"
}
}, - "external": {
- "id": "AH-129834"
}, - "fundraisingCampaign": {
- "id": "string"
}, - "id": "string",
- "images": [
- {
- "url": "string"
}
], - "location": {
- "city": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "name": "string",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "payments": {
- "invoice": "VAT"
}, - "product": {
- "id": "string"
}, - "promotion": {
- "bold": true,
- "departmentPage": true,
- "emphasized": true,
- "emphasizedHighlightBoldPackage": true,
- "highlight": true
}, - "publication": {
- "duration": "PT24H",
- "endingAt": "2031-01-04T11:01:59Z",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "endedBy": "USER",
- "republish": false
}, - "sellingMode": {
- "format": "BUY_NOW",
- "price": {
- "amount": "123.45",
- "currency": "PLN"
}, - "minimalPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "startingPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "netPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "sizeTable": {
- "id": "string"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}, - "updatedAt": "2019-08-24T14:15:22Z",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "language": "pl-PL"
}
Response samples
- 200
{- "additionalServices": {
- "id": "string"
}, - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}
}, - "attachments": [
- {
- "id": "1928302_MANUAL_45d7a0f543e1b0d05e12a1aef5642efe63389a1d419fe9286d0f158044391fdce"
}
], - "category": {
- "id": "257931"
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "contact": {
- "id": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "customParameters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "delivery": {
- "additionalInfo": "string",
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "shipmentDate": "2018-04-01T08:00:00Z"
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string"
}
}, - "external": {
- "id": "AH-129834"
}, - "fundraisingCampaign": {
- "id": "string"
}, - "id": "string",
- "images": [
- {
- "url": "string"
}
], - "location": {
- "city": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "name": "string",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "payments": {
- "invoice": "VAT"
}, - "product": {
- "id": "string"
}, - "promotion": {
- "bold": true,
- "departmentPage": true,
- "emphasized": true,
- "emphasizedHighlightBoldPackage": true,
- "highlight": true
}, - "publication": {
- "duration": "PT24H",
- "endingAt": "2031-01-04T11:01:59Z",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "endedBy": "USER",
- "republish": false
}, - "sellingMode": {
- "format": "BUY_NOW",
- "price": {
- "amount": "123.45",
- "currency": "PLN"
}, - "minimalPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "startingPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "netPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "sizeTable": {
- "id": "string"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}, - "updatedAt": "2019-08-24T14:15:22Z",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "language": "pl-PL"
}
Complete a draft offer or edit an offer
Authorizations:
allegro:api:sale:offers:write
) path Parameters
offerId required | string Offer identifier. |
Request Body schema: application/vnd.allegro.public.v1+json
offer
object (JustId) | |
object (AfterSalesServices) The definitions of the different after sales services assigned to the offer. | |
Array of objects (Attachment) [ items ] List of offer attachments. You can attach up to 7 files to the offer – one per each attachment type as described in uploading offer attachments flow. | |
object Category in which the offer is listed for sale | |
object (CompatibilityList) | |
object (JustId) | |
createdAt | string <date-time> Creation date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ. Cannot be modified. |
Array of objects (CustomParameter) [ items ] List of custom parameters. You can add up to 4 custom parameters, each containing exactly one value. | |
object (DeliveryFull) | |
object (StandardizedDescription) The description section cannot have more than 40000 bytes in length. | |
object (Discounts) | |
object (ExternalId) The information on the offer in an external system. | |
object (JustId) | |
id | string |
Array of objects (ImageUrl) [ items ] | |
object (Location) for offer with a delivery method it is a parcel dispatch location. For offers with personal pick-up it is a pick-up location, additionally we recommend to use points of service (https://developer.allegro.pl/documentation/#tag/Points-of-service) | |
name required | string <= 50 characters Name of the offer. Words used in the name field cannot be longer than 50 characters. |
Array of objects (Parameter) [ items ] | |
object (Payments) | |
object (JustId) | |
object (Promotion) | |
object (Publication) | |
object (SellingModeWithNetPrice) Information on the offer's selling mode. | |
object (ExtendedTax) VAT tax settings. Available settings can be found under "get all tax settings for category" resource. | |
object (JustId) | |
object (Stock) | |
object (TecdocSpecification) Contains additional information describing products from automotive categories. Technical specification is created based on TecDoc database and can only be used while creating offer with assigned product to it. Read more. | |
object (B2b) Defines offer properties for buyers with company account (Allegro Biznes). | |
object (MessageToSellerSettings) Defines message to the seller settings options. | |
updatedAt | string <date-time> Last update date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ. Cannot be modified |
object (Validation) | |
language | string <BCP-47 language code> Declared base language of the offer. |
Responses
Request samples
- Payload
{- "additionalServices": {
- "id": "string"
}, - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}
}, - "attachments": [
- {
- "id": "1928302_MANUAL_45d7a0f543e1b0d05e12a1aef5642efe63389a1d419fe9286d0f158044391fdce"
}
], - "category": {
- "id": "257931"
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "contact": {
- "id": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "customParameters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "delivery": {
- "additionalInfo": "string",
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "shipmentDate": "2018-04-01T08:00:00Z"
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string"
}
}, - "external": {
- "id": "AH-129834"
}, - "fundraisingCampaign": {
- "id": "string"
}, - "id": "string",
- "images": [
- {
- "url": "string"
}
], - "location": {
- "city": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "name": "string",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "payments": {
- "invoice": "VAT"
}, - "product": {
- "id": "string"
}, - "promotion": {
- "bold": true,
- "departmentPage": true,
- "emphasized": true,
- "emphasizedHighlightBoldPackage": true,
- "highlight": true
}, - "publication": {
- "duration": "PT24H",
- "endingAt": "2031-01-04T11:01:59Z",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "endedBy": "USER",
- "republish": false
}, - "sellingMode": {
- "format": "BUY_NOW",
- "price": {
- "amount": "123.45",
- "currency": "PLN"
}, - "minimalPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "startingPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "netPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "sizeTable": {
- "id": "string"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}, - "updatedAt": "2019-08-24T14:15:22Z",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "language": "pl-PL"
}
Response samples
- 200
{- "additionalServices": {
- "id": "string"
}, - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59"
}
}, - "attachments": [
- {
- "id": "1928302_MANUAL_45d7a0f543e1b0d05e12a1aef5642efe63389a1d419fe9286d0f158044391fdce"
}
], - "category": {
- "id": "257931"
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "contact": {
- "id": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "customParameters": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "delivery": {
- "additionalInfo": "string",
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "shipmentDate": "2018-04-01T08:00:00Z"
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string"
}
}, - "external": {
- "id": "AH-129834"
}, - "fundraisingCampaign": {
- "id": "string"
}, - "id": "string",
- "images": [
- {
- "url": "string"
}
], - "location": {
- "city": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "name": "string",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "payments": {
- "invoice": "VAT"
}, - "product": {
- "id": "string"
}, - "promotion": {
- "bold": true,
- "departmentPage": true,
- "emphasized": true,
- "emphasizedHighlightBoldPackage": true,
- "highlight": true
}, - "publication": {
- "duration": "PT24H",
- "endingAt": "2031-01-04T11:01:59Z",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "endedBy": "USER",
- "republish": false
}, - "sellingMode": {
- "format": "BUY_NOW",
- "price": {
- "amount": "123.45",
- "currency": "PLN"
}, - "minimalPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "startingPrice": {
- "amount": "123.45",
- "currency": "PLN"
}, - "netPrice": {
- "amount": "123.45",
- "currency": "PLN"
}
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "sizeTable": {
- "id": "string"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}, - "updatedAt": "2019-08-24T14:15:22Z",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "language": "pl-PL"
}
Delete a draft offer
Authorizations:
allegro:api:sale:offers:write
) path Parameters
offerId required | string Offer identifier. |
Responses
Batch offer publish / unpublish
Authorizations:
allegro:api:sale:offers:write
) path Parameters
commandId required | string Command identifier. |
Request Body schema: application/vnd.allegro.public.v1+json
publicationChangeCommandDto
Array of objects (OfferCriterium) [ items ] List of offer criteria | |
object (Publication_modification) Contains publication's fields to change |
Responses
Request samples
- Payload
{- "offerCriteria": [
- {
- "offers": [
- {
- "id": "123456789"
}
], - "type": "CONTAINS_OFFERS"
}
], - "publication": {
- "action": "ACTIVATE",
- "scheduledFor": "2019-08-24T14:15:22Z"
}
}
Response samples
- 201
{- "id": "string",
- "taskCount": {
- "failed": 0,
- "success": 0,
- "total": 0
}
}
Publish command summary
Authorizations:
allegro:api:sale:offers:write
) path Parameters
commandId required | string Command identifier. |
Responses
Response samples
- 200
{- "id": "string",
- "taskCount": {
- "failed": 0,
- "success": 0,
- "total": 0
}
}
Publish command detailed report
Authorizations:
allegro:api:sale:offers:write
) path Parameters
commandId required | string Command identifier. |
query Parameters
limit | integer <int32> [ 1 .. 1000 ] Default: 100 The limit of elements in the response. |
offset | integer <int32> [ 0 .. 999 ] Default: 0 The offset of elements in the response. |
Responses
Response samples
- 200
{- "tasks": [
- {
- "field": "string",
- "finishedAt": "2019-08-24T14:15:22Z",
- "message": "string",
- "offer": {
- "id": "123456789"
}, - "scheduledAt": "2019-08-24T14:15:22Z",
- "status": "string",
- "errors": [
- {
- "code": "NotAcceptableException",
- "details": null,
- "message": "Not acceptable representation requested. Please check 'Accept' request header",
- "path": null,
- "userMessage": "The request contains incorrect data. Contact the author of the application."
}
]
}
]
}
Response samples
- 200
- 401
{- "basePackages": [
- {
- "id": "promoPackage",
- "name": "Promo Package",
- "cycleDuration": "PT240H"
}
], - "extraPackages": [
- {
- "id": "promoPackage",
- "name": "Promo Package",
- "cycleDuration": "PT240H"
}
]
}
Modify offer promotion packages
Authorizations:
allegro:api:sale:offers:write
) path Parameters
offerId required | string Example: 9991337999 Offer identifier. |
Request Body schema: application/vnd.allegro.public.v1+json
request
Array of objects (PromoOptionsModification) [ items ] Promo package modifications to be applied. |
Responses
Request samples
- Payload
{- "modifications": [
- {
- "modificationType": "CHANGE",
- "packageType": "BASE",
- "packageId": "promoPackage"
}
]
}
Response samples
- 200
- 401
- 403
- 422
{- "basePackage": {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}, - "extraPackages": [
- {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}
], - "pendingChanges": {
- "basePackage": {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}
}
}
Get offer promotion packages
Authorizations:
allegro:api:sale:offers:read
) path Parameters
offerId required | string Example: 9991337999 Offer identifier. |
Responses
Response samples
- 200
- 401
- 403
{- "basePackage": {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}, - "extraPackages": [
- {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}
], - "pendingChanges": {
- "basePackage": {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}
}
}
Get promo options for seller's offers
Use this resource to retrieve promo options for seller offers.
Authorizations:
allegro:api:sale:offers:read
) query Parameters
limit | integer <int32> [ 1 .. 5000 ] Default: 5000 Limit of promo options per page. |
offset | integer <int64> >= 0 Default: 0 Distance between the beginning of the document and the point from which promo options are returned. |
Responses
Response samples
- 200
- 400
- 401
{- "promoOptions": [
- {
- "basePackage": {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}, - "extraPackages": [
- {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}
], - "pendingChanges": {
- "basePackage": {
- "id": "promoPackage",
- "validFrom": "2020-01-01T00:00:00Z",
- "validTo": "2020-01-01T00:00:00Z",
- "nextCycleDate": "2020-01-01T00:00:00Z"
}
}
}
], - "count": 3,
- "totalCount": 256
}
Batch offer promotion package modification
Authorizations:
allegro:api:sale:offers:write
) path Parameters
commandId required | string Example: aca8103b-14eb-4855-b9b3-de5bef06bd30 Command identifier. Must be a UUID. |
Request Body schema: application/vnd.allegro.public.v1+json
Promo packages modification command request.
Array of objects (OfferCriterium) [ items ] Offer choice criteria. | |
object (PromoOptionsCommandModification) |
Responses
Request samples
- Payload
{- "offerCriteria": [
- {
- "offers": [
- {
- "id": "123456789"
}
], - "type": "CONTAINS_OFFERS"
}
], - "modification": {
- "basePackage": {
- "id": "promoPackage"
}, - "extraPackages": [
- {
- "id": "promoPackage"
}
], - "modificationTime": "NOW"
}
}
Response samples
- 201
- 401
- 409
- 422
{- "id": "string",
- "taskCount": {
- "failed": 0,
- "success": 0,
- "total": 0
}
}
Modification command summary
Authorizations:
allegro:api:sale:offers:read
) path Parameters
commandId required | string Command identifier. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "id": "string",
- "taskCount": {
- "failed": 0,
- "success": 0,
- "total": 0
}
}
Modification command detailed result
Authorizations:
allegro:api:sale:offers:read
) path Parameters
commandId required | string Command identifier. |
query Parameters
limit | integer [ 1 .. 1000 ] Default: 100 The limit of returned items. |
offset | integer >= 0 Default: 0 The offset of returned items. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "tasks": [
- {
- "offer": {
- "id": "123456789"
}, - "scheduledAt": "2020-01-01T00:00:00Z",
- "finishedAt": "2020-01-01T00:00:00Z",
- "status": "FINISHED",
- "errors": {
- "code": "NotAcceptableException",
- "details": null,
- "message": "Not acceptable representation requested. Please check 'Accept' request header",
- "path": null,
- "userMessage": "The request contains incorrect data. Contact the author of the application."
}
}
], - "modification": {
- "basePackage": {
- "id": "promoPackage"
}, - "extraPackages": [
- {
- "id": "promoPackage"
}
], - "modificationTime": "NOW"
}
}
Create offer based on product
Authorizations:
allegro:api:sale:offers:write
) Request Body schema: application/vnd.allegro.public.v1+json
Array of objects[ items ] | |
object (B2b) Defines offer properties for buyers with company account (Allegro Biznes). | |
Array of objects (ProductOfferAttachment) [ items ] An array of offer attachments. | |
object (ProductOfferFundraisingCampaignRequest) | |
object (ProductOfferAdditionalServicesRequest) Offer additional services. | |
object | |
object | |
object For the | |
language | string <BCP-47 language code> Declared base language of the offer. |
object You can indicate a category from the product's 'similar categories' to set the offer's category. | |
Array of objects (ParameterProductOfferRequest) [ items ] | |
object (AfterSalesServicesProductOfferRequest) The definitions of the different after sales services assigned to the offer. | |
object The size table information. You should enter the size tabe identifier or name. | |
object (DiscountsProductOfferRequest) | |
name | string <= 50 characters Name of the offer. Words used in the name field cannot be longer than 50 characters. |
object (Payments) | |
object (SellingMode) Information on the offer's selling mode. | |
object (Location) for offer with a delivery method it is a parcel dispatch location. For offers with personal pick-up it is a pick-up location, additionally we recommend to use points of service (https://developer.allegro.pl/documentation/#tag/Points-of-service) | |
images | Array of strings |
object (StandardizedDescription) The description section cannot have more than 40000 bytes in length. | |
object (ExternalId) The information on the offer in an external system. | |
required | object (Stock) |
object (ExtendedTax) VAT tax settings. Available settings can be found under "get all tax settings for category" resource. | |
object (MessageToSellerSettings) Defines message to the seller settings options. |
Responses
Request samples
- Payload
{- "productSet": [
- {
- "product": {
- "name": "iPhone 5s",
- "category": {
- "id": "257931"
}, - "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "idType": "GTIN",
- "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "images": [
- "string"
]
}, - "quantity": {
- "value": 1
}
}
], - "b2b": {
- "buyableOnlyByBusiness": false
}, - "attachments": [
- {
- "id": "string"
}
], - "fundraisingCampaign": {
- "id": "string",
- "name": "string"
}, - "additionalServices": {
- "id": "string",
- "name": "string"
}, - "delivery": {
- "handlingTime": "PT24H",
- "shippingRates": null,
- "additionalInfo": "string",
- "shipmentDate": "2019-08-24T14:15:22Z"
}, - "publication": {
- "duration": "PT24H",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "republish": true
}, - "compatibilityList": {
- "items": [
- {
- "type": "TEXT",
- "text": "CITROËN C6 (TD_) 2005/09-2011/12 2.7 HDi 204KM/150kW"
}
]
}, - "language": "pl-PL",
- "category": {
- "id": "257931"
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
- "name": "string"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
- "name": "string"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
- "name": "string"
}
}, - "sizeTable": {
- "id": "string",
- "name": "string"
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string",
- "name": "string"
}
}, - "name": "string",
- "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": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "images": [
- "string"
], - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "external": {
- "id": "AH-129834"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}
}
Response samples
- 201
- 202
- 400
- 401
- 403
- 422
{- "productSet": [
- {
- "quantity": {
- "value": 1
}, - "product": {
- "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "publication": {
- "status": "PROPOSED"
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
]
}
}
], - "attachments": [
- {
- "id": "string"
}
], - "fundraisingCampaign": {
- "id": "string"
}, - "additionalServices": {
- "id": "string"
}, - "delivery": {
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "additionalInfo": "string",
- "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"
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "language": "pl-PL",
- "id": "string",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "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": "string"
}
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": {
- "id": "257931"
}, - "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": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "images": [
- "string"
], - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "external": {
- "id": "AH-129834"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "sizeTable": {
- "id": "string"
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}
}
Edit an offer
Authorizations:
path Parameters
offerId required | string The offer identifier. |
Request Body schema: application/vnd.allegro.public.v1+json
Array of objects[ items ] | |
object (B2b) Defines offer properties for buyers with company account (Allegro Biznes). | |
Array of objects (ProductOfferAttachment) [ items ] An array of offer attachments. | |
object (ProductOfferFundraisingCampaignRequest) | |
object (ProductOfferAdditionalServicesRequest) Offer additional services. | |
object For the | |
object | |
object | |
language | string <BCP-47 language code> Declared base language of the offer. |
object You can indicate a category from the product's 'similar categories' to set the offer's category. | |
Array of objects (ParameterProductOfferRequest) [ items ] | |
object (AfterSalesServicesProductOfferRequest) The definitions of the different after sales services assigned to the offer. | |
object The size table information. You should enter the size tabe identifier or name. | |
object (DiscountsProductOfferRequest) | |
name | string <= 50 characters Name of the offer. Words used in the name field cannot be longer than 50 characters. |
object (Payments) | |
object (SellingMode) Information on the offer's selling mode. | |
object (Location) for offer with a delivery method it is a parcel dispatch location. For offers with personal pick-up it is a pick-up location, additionally we recommend to use points of service (https://developer.allegro.pl/documentation/#tag/Points-of-service) | |
images | Array of strings |
object (StandardizedDescription) The description section cannot have more than 40000 bytes in length. | |
object (ExternalId) The information on the offer in an external system. | |
object (Stock) | |
object (ExtendedTax) VAT tax settings. Available settings can be found under "get all tax settings for category" resource. | |
object (MessageToSellerSettings) Defines message to the seller settings options. |
Responses
Request samples
- Payload
{- "productSet": [
- {
- "product": {
- "name": "iPhone 5s",
- "category": {
- "id": "257931"
}, - "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "idType": "GTIN",
- "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "images": [
- "string"
]
}, - "quantity": {
- "value": 1
}
}
], - "b2b": {
- "buyableOnlyByBusiness": false
}, - "attachments": [
- {
- "id": "string"
}
], - "fundraisingCampaign": {
- "id": "string",
- "name": "string"
}, - "additionalServices": {
- "id": "string",
- "name": "string"
}, - "compatibilityList": {
- "items": [
- {
- "type": "TEXT",
- "text": "CITROËN C6 (TD_) 2005/09-2011/12 2.7 HDi 204KM/150kW"
}
]
}, - "delivery": {
- "handlingTime": "PT24H",
- "shippingRates": null,
- "additionalInfo": "string",
- "shipmentDate": "2019-08-24T14:15:22Z"
}, - "publication": {
- "duration": "PT24H",
- "startingAt": "2031-01-04T11:01:59Z",
- "status": "INACTIVE",
- "republish": true
}, - "language": "pl-PL",
- "category": {
- "id": "257931"
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "afterSalesServices": {
- "impliedWarranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
- "name": "string"
}, - "returnPolicy": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
- "name": "string"
}, - "warranty": {
- "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
- "name": "string"
}
}, - "sizeTable": {
- "id": "string",
- "name": "string"
}, - "discounts": {
- "wholesalePriceList": {
- "id": "string",
- "name": "string"
}
}, - "name": "string",
- "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": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "images": [
- "string"
], - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "external": {
- "id": "AH-129834"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}
}
Response samples
- 200
- 202
- 400
- 401
- 403
- 422
{- "productSet": [
- {
- "quantity": {
- "value": 1
}, - "product": {
- "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "publication": {
- "status": "PROPOSED"
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
]
}
}
], - "attachments": [
- {
- "id": "string"
}
], - "fundraisingCampaign": {
- "id": "string"
}, - "additionalServices": {
- "id": "string"
}, - "delivery": {
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "additionalInfo": "string",
- "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"
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "language": "pl-PL",
- "id": "string",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "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": "string"
}
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": {
- "id": "257931"
}, - "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": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "images": [
- "string"
], - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "external": {
- "id": "AH-129834"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "sizeTable": {
- "id": "string"
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}
}
Get all data of the particular product-offer
Authorizations:
allegro:api:sale:offers:read
) path Parameters
offerId required | string Offer identifier. |
Responses
Response samples
- 200
{- "productSet": [
- {
- "quantity": {
- "value": 1
}, - "product": {
- "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "publication": {
- "status": "PROPOSED"
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
]
}
}
], - "attachments": [
- {
- "id": "string"
}
], - "fundraisingCampaign": {
- "id": "string"
}, - "additionalServices": {
- "id": "string"
}, - "delivery": {
- "handlingTime": "PT24H",
- "shippingRates": {
- "id": "string"
}, - "additionalInfo": "string",
- "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"
}, - "b2b": {
- "buyableOnlyByBusiness": false
}, - "compatibilityList": {
- "type": "MANUAL"
}, - "language": "pl-PL",
- "id": "string",
- "validation": {
- "errors": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "warnings": [
- {
- "code": "string",
- "details": "string",
- "message": "string",
- "path": "string",
- "userMessage": "string"
}
], - "validatedAt": "2019-08-24T14:15:22Z"
}, - "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": "string"
}
}, - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
]
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "category": {
- "id": "257931"
}, - "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": "string",
- "countryCode": "string",
- "postCode": "string",
- "province": "string"
}, - "images": [
- "string"
], - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "external": {
- "id": "AH-129834"
}, - "stock": {
- "available": 99,
- "unit": "UNIT"
}, - "sizeTable": {
- "id": "string"
}, - "tax": {
- "id": "ae727432-8b72-4bfe-b732-6f163a2bf32a",
- "rate": "23.00",
- "subject": "GOODS",
- "exemption": "MONEY_EQUIVALENT",
- "percentage": "23.00"
}, - "messageToSellerSettings": {
- "mode": "OPTIONAL"
}
}
Check the processing status of a POST or PATCH request
Authorizations:
allegro:api:sale:offers:read
) path Parameters
offerId required | string Offer identifier. |
operationId required | string Operation identifier provided in location header of POST or PATCH request. |
Responses
Response samples
- 202
{- "offer": {
- "id": "123456789"
}, - "operation": {
- "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
- "status": "IN_PROGRESS",
- "startedAt": "2019-05-29T12:00:00Z"
}
}
Get offers with missing parameters
Authorizations:
allegro:api:sale:offers:read
) query Parameters
offer.id | Array of strings List of offer ids. If empty all offers with unfilled parameters will be returned. |
parameterType | string Enum: "REQUIRED" "REQUIREMENT_PLANNED" Filter by parameter type. |
offset | integer <int32> >= 0 Default: 0 The offset of elements in the response. |
limit | integer <int32> [ 1 .. 1000 ] Default: 100 The limit of elements in the response. |
Responses
Response samples
- 200
{- "offers": [
- {
- "id": "8888203028",
- "parameters": [
- {
- "id": "14228"
}
], - "category": {
- "id": "257931"
}
}
], - "count": 3,
- "totalCount": 256
}
Get offer translations
Get offer translation for given language or all present.
Authorizations:
allegro:api:sale:offers:read
) path Parameters
offerId required | string Offer identifier. |
query Parameters
language | string <BCP-47 language code> Example: language=en-US Language for translation to retrieve. If not provided, all translations as well as base content for offer will be returned. |
Responses
Response samples
- 200
- 401
- 403
- 404
{- "translations": [
- {
- "description": {
- "translation": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}, - "type": "AUTO"
}, - "language": "en-US",
- "title": {
- "translation": "string",
- "type": "AUTO"
}
}
]
}
Update offer translation
Update manual translation for offer.
Authorizations:
allegro:api:sale:offers:write
) path Parameters
language required | string <BCP-47 language code> Example: en-US Language of the provided translation. |
offerId required | string Offer identifier. |
Request Body schema: application/vnd.allegro.public.v1+json
Request with manual translation for offer, must contain at least one translated offer element (title or description).
object (ManualDescriptionTranslation) Manual offer description translation | |
object (ManualTitleTranslation) Manual offer title translation |
Responses
Request samples
- Payload
{- "description": {
- "translation": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}
}, - "title": {
- "translation": "string"
}
}
Response samples
- 401
- 403
- 422
{- "error": "unauthorized",
- "error_description": "Full authentication is required to access this resource"
}
Delete offer translation
Delete single element or entire manual translation.
Authorizations:
allegro:api:sale:offers:write
) path Parameters
language required | string <BCP-47 language code> Example: en-US Language of the translation to delete. |
offerId required | string Offer identifier. |
query Parameters
element | string Enum: "title" "description" Offer element for which translation should be deleted. If not provided, translations for all elements will be deleted. |
Responses
Response samples
- 401
- 403
{- "error": "unauthorized",
- "error_description": "Full authentication is required to access this resource"
}
Get IDs of Allegro categories
Authorizations:
query Parameters
parent.id | string Default: "954b95b6-43cf-4104-8354-dea4d9b10ddf" The ID of the category which children should be returned. If omitted, the list of main Allegro categories will be returned. |
Responses
Response samples
- 200
- 404
{- "categories": [
- {
- "id": "12",
- "leaf": true,
- "name": "Pozostałe",
- "options": {
- "advertisement": true,
- "advertisementPriceOptional": true,
- "variantsByColorPatternAllowed": true,
- "offersWithProductPublicationEnabled": true,
- "productCreationEnabled": true,
- "customParametersEnabled": true
}, - "parent": {
- "id": "709"
}
}
]
}
Get a category by ID
Authorizations:
path Parameters
categoryId required | string Example: 6061 The category ID. |
Responses
Response samples
- 200
- 404
{- "id": "12",
- "leaf": true,
- "name": "Pozostałe",
- "options": {
- "advertisement": true,
- "advertisementPriceOptional": true,
- "variantsByColorPatternAllowed": true,
- "offersWithProductPublicationEnabled": true,
- "productCreationEnabled": true,
- "customParametersEnabled": true
}, - "parent": {
- "id": "709"
}
}
Get parameters supported by a category
Authorizations:
path Parameters
categoryId required | string Example: 709 The category ID. |
Responses
Response samples
- 200
- 404
{- "parameters": [
- {
- "id": "202877",
- "name": "Liczba rdzeni procesora",
- "type": "integer",
- "required": false,
- "requiredForProduct": false,
- "unit": null,
- "options": {
- "variantsAllowed": true,
- "variantsEqual": false,
- "ambiguousValueId": null,
- "dependsOnParameterId": "202870",
- "requiredDependsOnValueIds": [
- "202870_1"
], - "displayDependsOnValueIds": [
- "202870_1",
- "202870_2"
], - "describesProduct": false,
- "customValuesEnabled": false
}, - "restrictions": {
- "min": 0,
- "max": 1000000,
- "range": false
}
}
]
}
Get planned changes in category parameters
Use this resource to get information about planned changes in category parameters. Please note that in some cases, the returned events may finally not happen in the future. At present we support the following changes: - REQUIREMENT_CHANGE - the parameter will be required in the category. Read more: PL / EN.
Authorizations:
query Parameters
scheduledFor.gte | string <date-time> Example: scheduledFor.gte=2020-11-13T12:45:20.818Z The minimum date and time from which the change will be effective from in ISO 8601 format. Should be greater than the current date time and less than 3 months from the current date. |
scheduledFor.lte | string <date-time> Example: scheduledFor.lte=2020-11-13T12:45:20.818Z The maximum date and time from which the change will be effective from in ISO 8601 format. Should be greater than the current date time and less than 3 months from the current date. |
scheduledAt.gte | string <date-time> Example: scheduledAt.gte=2020-11-13T12:45:20.818Z The minimum date and time at which the change was scheduled in ISO 8601 format. |
scheduledAt.lte | string <date-time> Example: scheduledAt.lte=2020-11-13T12:45:20.818Z The maximum date and time at which the change was scheduled in ISO 8601 format. |
type | Array of strings Items Value: "REQUIREMENT_CHANGE" The types of changes that will be returned in the response. All types of changes are returned by default. |
offset | integer <int32> >= 0 Default: 0 The offset of elements in the response. |
limit | integer <int32> [ 1 .. 1000 ] Default: 100 The limit of elements in the response. |
Responses
Response samples
- 200
- 400
- 401
{- "scheduledAt": "2019-06-26T15:26:43.891Z",
- "scheduledFor": "2019-07-26T15:26:43.891Z",
- "type": "REQUIREMENT_CHANGE",
- "category": {
- "id": "165"
}, - "parameter": {
- "id": "11323"
}
}
Get changes in categories
Use this resource to get information about changes in categories. It returns changes that occurred in the last 3 months. At present we support the following changes:
- CATEGORY_CREATED - new category was created.
- CATEGORY_RENAMED - category name has been changed.
- CATEGORY_MOVED - category has been moved to a different place in category tree, category parent id field is changed.
- CATEGORY_DELETED - category is no longer available, category from redirectCategory field should be used instead.
Authorizations:
query Parameters
from | string <= 256 characters Example: from=MTEzMjQzODU3NA The ID of the last seen event. Changes that occurred after the given event will be returned. |
limit | integer [ 1 .. 1000 ] Default: 100 The number of events that will be returned in the response. |
type | Array of strings Items Enum: "CATEGORY_CREATED" "CATEGORY_RENAMED" "CATEGORY_MOVED" "CATEGORY_DELETED" The types of events that will be returned in the response. All types of events are returned by default. |
Responses
Response samples
- 200
- 400
- 401
{- "id": "MTEzMjQzODU3NA",
- "occurredAt": "2019-06-26T15:26:43.891Z",
- "type": "CATEGORY_CREATED",
- "category": {
- "id": "165",
- "name": "Smartphones and Cell Phones",
- "parent": {
- "id": "4"
}, - "leaf": false
}
}
Get categories suggestions
Authorizations:
query Parameters
name required | string Example: name=bmw x3 Product name for which you want to get suggested categories. |
Responses
Response samples
- 200
- 401
- 403
- 406
- 422
{- "matchingCategories": [
- {
- "id": "2",
- "name": "Samochody Osobowe",
- "parent": {
- "id": {
- "type": "string",
- "example": "1",
- "description": "Id of category."
}, - "name": {
- "type": "string",
- "example": "Motoryzacja",
- "description": "Category name."
}, - "parent": {
- "type": "object",
- "description": "Parent category object."
}
}
}
]
}
Upload an offer image
Upload image to our servers. You can choose from two upload options:
- - provide a link and we will download an image for you
- - send an image as binary data
Important! Remember to use dedicated domain for upload, i.e.
- - https://upload.allegro.pl for Production
- - https://upload.allegro.pl.allegrosandbox.pl for Sandbox
Read more: PL / EN. More information about rules for photos in an offer's gallery and description you will find here.
Authorizations:
allegro:api:sale:offers:write
) Request Body schema: application/vnd.allegro.public.v1+jsonapplication/vnd.allegro.public.v1+jsonimage/jpegimage/pngimage/webp
url required | string URL of the image. It has to contain domain name, not an IP address. Currently we support http and https protocols. When using https the certificate chain needs to be valid. |
Responses
Request samples
- Payload
{- "url": "string"
}
Response samples
- 201
{- "expiresAt": "2019-08-24T14:15:22Z",
- "location": "string"
}
Create an offer attachment
You can attach pdf, jpeg or png files to your offers. We will present them under the offer description in the Additional information section. You can attach up to 9 files to one offer – one per each type from the list:
- Guide (MANUAL)
- Special offer terms (SPECIAL_OFFER_RULES)
- Competition terms (COMPETITION_RULES)
- Book excerpt (BOOK_EXCERPT)
- Manual (USER_MANUAL)
- Installation manual (INSTALLATION_INSTRUCTIONS)
- Game manual (GAME_INSTRUCTIONS)
- Energy label (ENERGY_LABEL)
- Product information sheet (PRODUCT_INFORMATION_SHEET)
Uploading attachments flow:
- Create an attachment object to receive an upload URL (POST /sale/offer-attachments),
- Use the upload URL to submit the file (PUT /sale/offer-attachments/{attachmentId}),
- Add attachments to the offer (PUT /sale/offers/{offerId}).
Authorizations:
allegro:api:sale:offers:write
) Request Body schema: application/vnd.allegro.public.v1+json
offer attachment
type | string (AttachmentType) Enum: "MANUAL" "SPECIAL_OFFER_RULES" "COMPETITION_RULES" "BOOK_EXCERPT" "USER_MANUAL" "INSTALLATION_INSTRUCTIONS" "GAME_INSTRUCTIONS" "ENERGY_LABEL" "PRODUCT_INFORMATION_SHEET" offer attachment type |
object (AttachmentFileRequest) |
Responses
Request samples
- Payload
{- "type": "MANUAL",
- "file": {
- "name": "string"
}
}
Response samples
- 201
{- "id": "string",
- "type": "MANUAL",
- "file": {
- "name": "string",
- "url": "string"
}
}
Upload an offer attachment
Upload an offer attachment. This operation should be used after creating an offer attachment with POST /sale/offer-attachments Important! You can find the URL address to upload the file to our server in the Location response header of POST /sale/offer-attachments. The URL is unique and one-time. As its format may change in time, you should always use the address from the header. Do not compose the address on your own. Read more: PL / EN.
Authorizations:
allegro:api:sale:offers:write
) path Parameters
attachmentId required | string <uuid> The ID of the attachment. |
Request Body schema: application/pdfapplication/pdfimage/jpegimage/png
File in a binary format
Responses
Get product parameters available in given category
Authorizations:
path Parameters
categoryId required | string Example: 709 The category ID. |
Responses
Response samples
- 200
- 404
{- "parameters": [
- {
- "id": "202877",
- "name": "Liczba rdzeni procesora",
- "type": "integer",
- "required": false,
- "unit": null,
- "restrictions": {
- "min": 0,
- "max": 1000000,
- "range": false
}
}
]
}
Get search products results
Use this resource to get a list of products according to provided parameters. At least ean or phrase parameter is required. Read more: PL / EN. This resource is limited with Leaky Bucket mechanism.
Authorizations:
allegro:api:sale:offers:read
) query Parameters
ean | string <= 18 characters Deprecated The EAN values can include EAN, ISBN, and UPC identifier types. Parameter is depracated and will be removed in the future. Please use combination of phrase and mode ( |
phrase | string <= 1024 characters Search phrase. |
mode | string Enum: "GTIN" "MPN" Search mode. If not specified, we are searching by GTIN, MPN, product's name, parameters, etc.
|
category.id | string The category identifier to filter results. This can only be used when searching by phrase. |
object You can filter and customize your search results to find exactly what you need by applying filters ids and their dictionary values to query according to the flowing pattern: id=value. When the filter definition looks like:
You can use 'Kolor' filter to query results, i.e.:
| |
page.id | string A "cursor" to the next set of results. |
searchFeatures | string Value: "SIMILAR_CATEGORIES" Enables additional search options: - SIMILAR_CATEGORIES - searching in the indicated category (category.id) and in 'similar categories' (works only if category.id is a leaf category). |
Responses
Response samples
- 200
- 401
- 422
{- "products": [
- {
- "id": "string",
- "name": "string",
- "category": {
- "id": "257931",
- "similar": [
- {
- "id": "257931"
}
]
}, - "images": [
- {
- "url": "string"
}
], - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
]
}
], - "categories": {
- "subcategories": [
- {
- "id": "string",
- "name": "string",
- "count": 0
}
], - "path": [
- {
- "id": "string",
- "name": "string"
}
]
}, - "filters": [
- {
- "id": "campaign",
- "type": "MULTI",
- "name": "kampania",
- "values": [
- {
- "name": "raty zero",
- "value": "INSTALLMENTS_ZERO",
- "idSuffix": ".to",
- "count": 123,
- "selected": true
}
], - "minValue": 0,
- "maxValue": 1000,
- "unit": "zł"
}
], - "nextPage": {
- "id": "string"
}
}
Get all data of the particular product
Use this resource to retrieve all data of the particular product. Read more: PL / EN. This resource is limited with Leaky Bucket mechanism.
Authorizations:
allegro:api:sale:offers:read
) path Parameters
productId required | string The product identifier. |
query Parameters
category.id | string The similar category identifier. You can choose a category from 'similar categories' to filter the list of parameters available in the category context. |
Responses
Response samples
- 200
- 401
- 404
{- "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "name": "iPhone 5s",
- "category": {
- "id": "257931",
- "similar": [
- {
- "id": "257931"
}
]
}, - "images": [
- {
- "url": "string"
}
], - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
], - "offerRequirements": {
- "id": "2865624934",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
]
}, - "compatibilityList": {
- "id": "460b2511-b786-47b9-9d7e-1f868728cfd6-f103931434fbf4aa06764f3df74d371df23aa138a9cd46dbe570f51af79db1c4-2",
- "type": "PRODUCT_BASED",
- "items": [
- {
- "text": "AUDI 90 (89, 89Q, 8A, B3) 1988/06-1991/09 2.3 E 20V quattro 170KM/125kW 1501"
}
]
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}
}
Propose a product
Authorizations:
allegro:api:sale:offers:write
) Request Body schema: application/vnd.allegro.public.v1+json
name required | string <= 50 characters Suggested product name. |
required | object (Category) Category in which the offer is listed for sale |
required | Array of objects (ImageUrl) [ items ] List of product images. At least one image is required. |
required | Array of objects (ProductParameter) [ items ] List of product parameters. |
object (StandardizedDescription) The description section cannot have more than 40000 bytes in length. |
Responses
Request samples
- Payload
{- "name": "iPhone 5s",
- "category": {
- "id": "257931"
}, - "images": [
- {
- "url": "string"
}
], - "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
], - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}
}
Response samples
- 201
- 400
- 401
- 403
- 409
- 422
{- "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
- "name": "iPhone 5s",
- "category": {
- "id": "257931",
- "similar": [
- {
- "id": "257931"
}
]
}, - "images": [
- {
- "url": "string"
}
], - "parameters": [
- {
- "id": "string",
- "name": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
], - "offerRequirements": {
- "id": "2865624934",
- "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
]
}, - "compatibilityList": {
- "id": "460b2511-b786-47b9-9d7e-1f868728cfd6-f103931434fbf4aa06764f3df74d371df23aa138a9cd46dbe570f51af79db1c4-2",
- "type": "PRODUCT_BASED",
- "items": [
- {
- "text": "AUDI 90 (89, 89Q, 8A, B3) 1988/06-1991/09 2.3 E 20V quattro 170KM/125kW 1501"
}
]
}, - "tecdocSpecification": {
- "id": "470b8513-b786-b7b9-9e7e-2f848729cfd6",
- "items": [
- {
- "name": "Wersja TecDoc",
- "values": [
- "0319"
]
}
]
}, - "description": {
- "sections": [
- {
- "items": [
- {
- "type": "string"
}
]
}
]
}
}
Propose changes in product
Use this resource to propose changes in product.
Authorizations:
allegro:api:sale:offers:write
) path Parameters
productId required | string The product identifier. |
Request Body schema: application/vnd.allegro.public.v1+json
name required | string <= 150 characters Proposed product name. |
note | string <= 500 characters Note about product changes proposal. |
required | object (Category) Category in which the offer is listed for sale |
required | Array of objects (ImageUrl) [ items ] List of product images. At least one image is required. |
required | Array of objects (ProductParameter) [ items ] List of product parameters. |
notifyViaEmailAfterVerification | boolean Receive an email notification after product changes proposal resolution. |
Responses
Request samples
- Payload
{- "name": "iPhone 5s",
- "note": "Some additional note to product changes proposal.",
- "category": {
- "id": "257931"
}, - "images": [
- {
- "url": "string"
}
], - "parameters": [
- {
- "id": "string",
- "rangeValue": {
- "from": "string",
- "to": "string"
}, - "values": [
- "string"
], - "valuesIds": [
- "string"
], - "valuesLabels": [
- "string"
], - "unit": "string",
- "options": {
- "identifiesProduct": true
}
}
], - "notifyViaEmailAfterVerification": true
}
Response samples
- 201
- 400
- 401
- 404
- 422
{- "id": "string",
- "name": {
- "current": "string",
- "proposal": "string",
- "message": "string",
- "resolutionType": "UNRESOLVED"
}, - "category": {
- "current": "string",
- "proposal": "string",
- "message": "string",
- "resolutionType": "UNRESOLVED"
}, - "note": "Some additional note to product changes proposal.",
- "images": [
- {
- "current": "string",
- "proposal": "string",
- "message": "string",
- "resolutionType": "UNRESOLVED"
}
], - "parameters": [
- {
- "parameterId": "string",
- "values": [
- {
- "current": "string",
- "proposal": "string",
- "message": "string",
- "resolutionType": "UNRESOLVED"
}
]
}
], - "notifyViaEmailAfterVerification": true
}
Get all data of the particular product changes proposal
Use this resource to retrieve all data of the particular product changes proposal.
Authorizations:
allegro:api:sale:offers:read
) path Parameters
changeProposalId required | string The product changes proposal identifier. |