The list of all the error objects explaining the error.
-| Error code | -Metadata key | -Description | -
|---|---|---|
| PARAMETER_MISMATCH | -productId | -ID of an existing product that was matched to your request, but has parameter differences | -
| MultipleProductsFoundException | -foundProductsIds | -IDs of existing products that were matched to provided product id (GTIN or MPN). | -
| CATEGORY_MISMATCH | -requestedCategoryName | -Name of the requested category in the offer | -
| requestedCategoryId | -ID of the requested category in the offer | -|
| existingCategoryName | -Name of the existing category in the product | -|
| existingCategoryId | -ID of the existing category in the product | -|
| DefaultImpliedWarrantyNotFoundException | -defaultName | -Name to be selected if none provided | -
| InvalidDictionaryParameter | -dictionaryValue | -Requested invalid value | -
| parameterId | -Parameter ID in which the value does not exist | -|
| parameterName | -Parameter name | -|
| AdditionalServicesGroupNotFoundException | -requestedName | -Requested name | -
| DictionaryParameterIdsAndValuesNotMatch | -parameterId | -Parameter ID in which number of requested values and ids don't match | -
| parameterName | -Parameter name | -|
| GallerySizeException | -gallerySizeLimit | -Max number of images in this request | -
| UnsupportedLanguageException | -availableLocales | -Comma-separated list of supported locales | -
| UploadImageRequestTimeoutException | -imageUrl | -Requested image URL | -
| NotUniqueSizeTableException | -requestedName | -Requested name which was not found in your settings | -
| DictionaryParameterValueNotFound | -parameterName | -Parameter name to which requested value was not matched | -
| requestedDictionaryValue | -Requested value | -|
| CompatibilityListCategoryNotSupportedException | -requestedName | -Requested compatibility list name | -
| BaseMarketplaceInAdditionalMarketplacesException | -baseMarketplace | -Code of the base marketplace which should not have been sent | -
| ContactNotFoundException | -requestedName | -Requested contact name | -
| DictionaryParameterValueNotUnique | -parameterName | -Parameter name related to the error | -
| requestedDictionaryValue | -Repeated dictionary value | -|
| DictionaryParameterIdNotFound | -parameterId | -Parameter id related to the error | -
| parameterName | -Parameter name related to the error | -|
| WarrantyNotUniqueException | -requestedName | -Requested warranty name that is repeated in your configuration | -
| UnsupportedAdditionalMarketplaceException | -supportedAdditionalMarketplaces | -Code of requested marketplace that is not supported | -
| ProductNotFoundException | -productId | -Requested product id which was not found | -
| CATEGORY_NOT_EXISTS | -categoryId | -Requested category id which was not found | -
| FundraisingCampaignNotFoundException | -requestedName | -Requested campaign name which was not found | -
| WholesalePriceListNotFoundException | -requestedName | -Requested price-list which was not found | -
| ImpliedWarrantyNotFoundException | -defaultName | -Default name which would match automatically | -
| requestedName | -Requested name of implied warranty which was not found | -|
| NotUniqueWholesalePriceListException | -wholesalePriceList | -Requested name of price list which is repeated in your configuration | -
| FundraisingCampaignNotUniqueException | -requestedName | -Requested name of campaign which is repeated in your configuration | -
| ParameterNameNotFoundException | -categoryId | -Category id related to the error | -
| parameterName | -Requested parameter name which was not found | -|
| ReturnPolicyNotFoundException | -defaultName | -Default name which would match automatically | -
| requestedName | -Requested name of policy which was not found | -|
| UnknownProductOfferPartException | -requestedPart | -Requested offer part which was is not supported | -
| validParts | -Valid parts of the product offer | -|
| ParameterNameNotUniqueException | -categoryId | -Category id related to the error | -
| parameterName | -Requested parameter name which is not unique | -|
| SizeTableNotFoundException | -requestedName | -Requested size table name which was not found | -
| NotUniqueAdditionalServicesGroupException | -requestedName | -Requested name of additional services group which is repeated in your configuration | -
| ShippingRatesNotFoundException | -defaultName | -Default name which would match automatically | -
| requestedName | -Requested name of shipping rates which was not found | -|
| IncompleteParameterDefinition | -parameterId | -Parameter id related to the error | -
| CompatibilityListUnsupportedItemsTypeException | -categoryId | -Category id related to the error | -
| requestedItemType | -Requested item type which is not supported | -|
| INVALID_CATEGORY_ID | -categoryId | -Requested category id which is not valid | -
| ReturnPolicyNotUniqueException | -requestedName | -Requested name of return policy which is repeated in your configuration | -
| ParameterIdNotFoundException | -categoryId | -Category id related to the error | -
| parameterId | -Requested parameter id which was not found | -|
| WarrantyNotFoundException | -requestedName | -Requested name of warranty which was not found | -
| DefaultReturnPolicyNotFoundException | -defaultName | -Default name which would match automatically | -
| CompatibilityListUnknownItemsTypeException | -requestedName | -Requested type of the item which is not supported | -
| ContactNotUniqueException | -requestedName | -Requested name of contact which is repeated in your configuration | -
| OfferNotFoundException | -offerId | -Requested offer id which was not found | -
| UserNotFoundException | -userId | -Requested user id which was not found | -
| DefaultShippingRatesNotFoundException | -defaultName | -Default name which would match automatically | -
| NonUniqueShippingRatesException | -requestedName | -Requested name of shipping rates which is repeated in your configuration | -
| ParameterCategoryException | -parameterId | -Parameter id related to the error | -
| parameterName | -Parameter name related to the error | -|
| requestedParameterType | -Requested parameter type which is not valid | -|
| PublicationTasksNotFoundException | -commandId | -Requested command id which was not found | -
| TransactionTaxSettingsNotFoundException | -requestedTaxCountry | -Requested tax country which was not found | -
| requestedTaxExemption | -Requested tax exemption which was not found | -|
| requestedTaxRate | -Requested tax rate which was not found | -|
| requestedTaxSubject | -Requested tax subject which was not found | -|
| taxSettingsId | -Tax settings id related to the error | -|
| ImpliedWarrantyNotUniqueException | -requestedName | -Requested name of implied warranty which is repeated in your configuration | -
The list of all the error objects explaining the error.
- -| Error code | -Metadata key | -Description | -
|---|---|---|
| PARAMETER_MISMATCH | -productId | -ID of an existing product that was matched to your request, but has parameter differences | -
| MultipleProductsFoundException | -foundProductsIds | -IDs of existing products that were matched to provided product id (GTIN or MPN). | -
Restrictions:
-Filtering by promotion type is required.
- -Sum of limit and offset must be equal to or lower than 50000. Limit must be equal to or lower than 5000.
-Example:
-offset = 49950 and limit = 50 will return promotions
-offset = 49950 and limit = 51 will return 422 http error
-offset = 0 and limit = 5000 will return promotions
-offset = 0 and limit = 5001 will return 422 http error
- -Read more about: Large order discount PL / EN, Wholesale price list PL / EN, Multipack PL / EN.
- - operationId: listSellerPromotionsUsingGET_1 - parameters: - - name: limit - in: query - description: Limit of promotions per page. - required: false - schema: - type: integer - format: int32 - minimum: 1 - maximum: 5000 - default: 50 - - name: offset - in: query - description: Distance between the beginning of the document and the point from which promotions are returned. - required: false - schema: - type: integer - format: int32 - minimum: 0 - maximum: 49999 - default: 0 - - name: offer.id - in: query - description: Filter by offer id. No promotions with `OFFERS_ASSIGNED_EXTERNALLY` or `ALL_OFFERS` criteria will be returned if this parameter is present. - schema: - type: string - example: "8226673525" - - name: promotionType - in: query - description: Filter by promotion type. - required: true - schema: - type: string - enum: - - MULTIPACK - - CROSS_MULTIPACK - - LARGE_ORDER_DISCOUNT - - WHOLESALE_PRICE_LIST - responses: - '200': - description: Successfully returned the requested list of promotions - content: - application/vnd.allegro.public.v1+json: - schema: - $ref: '#/components/schemas/SellerRebatesDto' - '400': - description: Bad request - '401': - description: Unauthorized action - content: - application/vnd.allegro.public.v1+json: - schema: - $ref: '#/components/schemas/AuthError' - '422': - description: Restrictions were not satisfied - content: - application/vnd.allegro.public.v1+json: - schema: - $ref: '#/components/schemas/ErrorsHolder' - security: - - bearer-token-for-user: - - allegro:api:sale:offers:read - /sale/loyalty/promotions/{promotionId}: - get: - tags: - - Rebates and promotions - summary: "Get a promotion data by id" - description: >- -Example text
" - DescriptionSectionItemImage: - allOf: - - $ref: '#/components/schemas/DescriptionSectionItem' - - type: object - properties: - type: - type: string - default: 'IMAGE' - url: - type: string - example: "https://a.allegroimg.com/original/00e0c9/1d7c95614fd6a7c713b075d0251a" - EmailRequest: - type: object - properties: - address: - type: string - maxLength: 128 - description: The contact's email address. The user part (before `@`) cannot be longer than 64 characters. - EmailResponse: - type: object - properties: - address: - type: string - Error: - type: object - properties: - code: - type: string - description: The error code. You can use this code when contacting us about any problems with our systems. - example: "NotAcceptableException" - details: - type: string - nullable: true - description: >- - For some cases, this field provides more details regarding the error. This field can be empty. - example: '' - message: - type: string - description: >- - A message directed to the developer of the program. This message will always be in English and give you - some more technical details on what exactly has happened. - example: Not acceptable representation requested. Please check 'Accept' request header - path: - type: string - nullable: true - description: >- - This field will point to a specific field in object if the error is connected to a problem with such specific - field. This field can be empty - example: '' - userMessage: - type: string - description: >- - The message that can be presented directly to your user. It will not contain any technical information. This - message is translated based on the value of the "Accept-Language" header. By default message in English is - returned. - example: The request contains incorrect data. Contact the author of the application. - metadata: - type: object - additionalProperties: - type: string - description: >- - Additional technical properties of this error. Set of possible keys depends on the specific error. - example: {"productId": "13232515"} - # DEVELOPMENT HINT - # When adding a new metadata field, add a table to respective error response description. - # See Response 422 of PATCH /sale/product-offers/{offerId} for real-life example - # Preferred table format: - #| Error code | - #Metadata key | - #Description | - #
|---|---|---|
| PARAMETER_MISMATCH | - #productId | - #ID of an existing product that was matched to your request, but has parameter differences | - #
| parameterId | - #ID of problematic parameter | - #
| Error code | - #Metadata key | - #Description | - #
|---|---|---|
| PARAMETER_MISMATCH | - #productId | - #ID of an existing product that was matched to your request, but has parameter differences | - #
| parameterId | - #ID of problematic parameter | - #
| Error code | - #Metadata key | - #Description | - #
|---|---|---|
| PARAMETER_MISMATCH | - #productId | - #ID of an existing product that was matched to your request, but has parameter differences | - #
| parameterId | - #ID of problematic parameter | - #
responsibleProducer.
- properties:
- id:
- type: string
- example: "570c928f-39ac-4838-93bb-eb829bc2136f"
- responsibleProducer:
- type: object
- description: >-
- Reference to the responsible producer configured using Responsible Producer API. Note that
- this is a different field than responsiblePerson.
- properties:
- id:
- type: string
- example: "33960380-98fe-4b3d-b69e-b261526f2730"
- - $ref: '#/components/schemas/ProductSetElementSafetyInformationWrapper'
- - $ref: '#/components/schemas/MarketedBeforeGPSRObligation'
- category:
- $ref: '#/components/schemas/OfferCategory'
- attachments:
- $ref: '#/components/schemas/ProductOfferAttachment'
- fundraisingCampaign:
- $ref: '#/components/schemas/ProductOfferFundraisingCampaignResponse'
- additionalServices:
- $ref: '#/components/schemas/ProductOfferAdditionalServicesResponse'
- delivery:
- $ref: '#/components/schemas/DeliveryProductOfferResponse'
- publication:
- $ref: '#/components/schemas/SaleProductOfferPublicationResponse'
- additionalMarketplaces:
- $ref: '#/components/schemas/AdditionalMarketplacesResponse'
- b2b:
- $ref: '#/components/schemas/B2b'
- compatibilityList:
- $ref: '#/components/schemas/CompatibilityListProductOfferResponse'
- language:
- type: string
- description: Declared base language of the offer.
- format: BCP-47 language code
- example: 'pl-PL'
- validation:
- $ref: '#/components/schemas/Validation'
- warnings:
- allOf:
- - $ref: '#/components/schemas/Errors'
- - description: >-
- Information about any problems that occurred during request processing, for example: some details
- may not have been saved, but the offer creation could continue. It is advised to present
- this data similarly to validation.warnings.
- afterSalesServices:
- $ref: '#/components/schemas/AfterSalesServices'
- discounts:
- $ref: '#/components/schemas/DiscountsProductOfferResponse'
- stock:
- $ref: '#/components/schemas/Stock'
- parameters:
- type: array
- items:
- $ref: '#/components/schemas/ParameterProductOfferResponse'
- description: List of offer parameters.
- contact:
- allOf:
- - $ref: '#/components/schemas/Contact'
- description: >-
- Identifier of contact data for sales format ADVERTISEMENT (classified ad);
- retrieve it via GET /sale/offer-contacts.
- createdAt:
- type: string
- format: date-time
- description: >-
- Creation date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ.
- Cannot be modified.
- updatedAt:
- type: string
- format: date-time
- description: >-
- Last update date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ.
- Cannot be modified.
- - $ref: '#/components/schemas/SaleProductOffer'
- SalePartialProductOfferResponse:
- type: object
- properties:
- id:
- type: string
- description: Offer's ID
- example: "12394584234"
- stock:
- type: object
- description: Number of times this offer can be purchased (available for include=stock).
- properties:
- available:
- type: integer
- format: int32
- minimum: 0
- example: 99
- sellingMode:
- type: object
- description: Offer's price information for base marketplace (available for include=price).
- properties:
- price:
- $ref: '#/components/schemas/Price'
- additionalMarketplaces:
- type: object
- description: Information about this offer in additional marketplaces (available for include=price).
- additionalProperties:
- x-additionalPropertiesName: marketplaceId
- type: object
- properties:
- sellingMode:
- type: object
- description: Price information for given addtional marketplace.
- properties:
- price:
- $ref: '#/components/schemas/Price'
- SaleProductOfferStatusResponse:
- type: object
- properties:
- offer:
- $ref: '#/components/schemas/OfferId'
- operation:
- type: object
- properties:
- id:
- type: string
- description: 'The unique operation identifier (UUID).'
- example: "b572cdd0-7f2c-4800-9165-15795bd95f3c"
- status:
- type: string
- description: 'Status of the operation.'
- enum:
- - "PENDING"
- - "IN_PROGRESS"
- - "COMPLETED"
- example: "IN_PROGRESS"
- startedAt:
- type: string
- format: ISO 8601
- description: 'The starting date and time of operation.'
- example: '2019-05-29T12:00:00Z'
- description: Single opertion data.
- ProductOfferBase:
- type: object
- properties:
- id:
- type: string
- example: c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4
- description: Product id.
- idType:
- type: string
- enum:
- - GTIN
- - MPN
- description: >-
- Type of id. This field is optional. It helps in finding products more accurately. If an idType is not set, a given id is understood as a product's id.
- - `GTIN` - restricts the search filtering to GTINs (Global Trade Item Number), e.g. EAN, ISBN, UPC.
- - `MPN` - restricts the search filtering to MPNs (Manufacturer Part Number).
- parameters:
- type: array
- items:
- $ref: '#/components/schemas/ParameterProductOfferRequest'
- description: List of product parameters.
- images:
- type: array
- items:
- type: string
- example: "https://a.allegroimg.com/original/12068b/359d04074521b79df1b2807a6727"
- description: List of product images.
- ProductOffer:
- allOf:
- - type: object
- properties:
- name:
- type: string
- description: Product name.
- example: iPhone 5s
- maxLength: 75
- category:
- $ref: '#/components/schemas/ProductCategory'
- - $ref: '#/components/schemas/ProductOfferBase'
- ProductSetElement:
- type: object
- properties:
- product:
- allOf:
- - $ref: '#/components/schemas/ProductOffer'
- description: You should enter the product identifier (UUID or EAN) or a complete product definition.
- ProductSetElementQuantity:
- type: object
- properties:
- quantity:
- type: object
- properties:
- value:
- type: integer
- example: 1
- minimum: 1
- description: >-
- The number of a given product included in a single offer sold as an element of a product set.
- **Note:** For number of sets available in stock, use `stock.available` property.
- ProductSetElementResponsiblePersonRequest:
- type: object
- properties:
- responsiblePerson:
- type: object
- description: >-
- Reference to the responsible person configured using
- Responsible
- Persons API. Provide either id or name - id will be used if both are provided. Setting
- this object to null will result in no responsible person assigned to this product.
- properties:
- id:
- type: string
- example: 33960380-98fe-4b3d-b69e-b261526f2730
- description: >-
- Identifier of a responsible person.
- name:
- type: string
- description: >-
- Name of a responsible person. Note that this references name of the person object,
- not the name in their personal data section.
- ProductSetElementResponsibleProducerRequestWrapper:
- type: object
- properties:
- responsibleProducer:
- $ref: '#/components/schemas/ProductSetElementResponsibleProducerRequest'
- example:
- responsibleProducer:
- type: 'ID'
- id: '12345678-9abc-def1-2345-6789abcdef12'
- ProductSetElementResponsibleProducerRequest:
- type: object
- properties:
- type:
- type: string
- default: 'ID'
- example: 'ID'
- required:
- - type
- discriminator:
- propertyName: type
- mapping:
- ID: '#/components/schemas/ProductSetElementResponsibleProducerIdRequest'
- NAME: '#/components/schemas/ProductSetElementResponsibleProducerNameRequest'
- description: >-
- Reference to the responsible producer configured using
- Responsible
- Producers API.
- ProductSetElementResponsibleProducerIdRequest:
- allOf:
- - $ref: '#/components/schemas/ProductSetElementResponsibleProducerRequest'
- - type: object
- properties:
- type:
- type: string
- id:
- type: string
- description: ID of responsible producer
- example: '12345678-9abc-def1-2345-6789abcdef12'
- ProductSetElementResponsibleProducerNameRequest:
- allOf:
- - $ref: '#/components/schemas/ProductSetElementResponsibleProducerRequest'
- - type: object
- properties:
- type:
- type: string
- name:
- type: string
- description: >-
- Name of responsible producer. **Note:** This refers to the name property and not
- the producerData.tradeName property of responsible producer defined using
- Responsible
- Producers API.
- example: 'your producer name'
- maxLength: 50
- minLength: 1
- ProductSetElementSafetyInformationWrapper:
- type: object
- properties:
- safetyInformation:
- $ref: '#/components/schemas/ProductSetElementSafetyInformation'
- example:
- safetyInformation:
- type: 'TEXT'
- description: string
- ProductSetElementSafetyInformation:
- type: object
- properties:
- type:
- type: string
- example: 'TEXT'
- required:
- - type
- discriminator:
- propertyName: type
- mapping:
- TEXT: '#/components/schemas/ProductSetElementTextSafetyInformation'
- ATTACHMENTS: '#/components/schemas/ProductSetElementAttachmentSafetyInformation'
- NO_SAFETY_INFORMATION: '#/components/schemas/ProductSetElementNoSafetyInformation'
- description: >-
- Contains information about product's safety.
- Reference Docs
- ProductSetElementNoSafetyInformation:
- allOf:
- - $ref: '#/components/schemas/ProductSetElementSafetyInformation'
- - type: object
- properties:
- type:
- description: The option is deprecated and will be removed in the future.
- deprecated: true
- type: string
- ProductSetElementAttachmentSafetyInformation:
- allOf:
- - $ref: '#/components/schemas/ProductSetElementSafetyInformation'
- - type: object
- properties:
- type:
- type: string
- attachments:
- type: array
- items:
- type: object
- properties:
- id:
- type: string
- example: 11a2df7f-8237-4625-baa2-cb7541f39946
- description: Id of the attachment.
- ProductSetElementTextSafetyInformation:
- allOf:
- - $ref: '#/components/schemas/ProductSetElementSafetyInformation'
- - type: object
- properties:
- type:
- type: string
- description:
- type: string
- example: 'Contains small parts'
- description: Safety warnings and instructions for the product in plain text form, if the information cannot be provided through attachments. Text can't be longer than 5000 characters.
- MarketedBeforeGPSRObligation:
- type: object
- properties:
- marketedBeforeGPSRObligation:
- type: boolean
- nullable: true
- example: true
- description: Allows you to declare that the product was introduced before 13 Dec 2024 and therefore does not require GPSR data.
- ProductOfferResponse:
- type: object
- properties:
- id:
- type: string
- example: c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4
- description: Product id.
- publication:
- type: object
- properties:
- status:
- type: string
- example: "LISTED"
- enum:
- - PROPOSED
- - LISTED
- - NOT_LISTED
- - REMOVED
- description: >-
- The publication status of the product assigned to the offer:
- - `PROPOSED` - a new product proposal was created or an existing product in the review process was selected and assigned to the offer
- - `LISTED` - a reviewed product from our database was identified and assigned to the offer
- - `NOT_LISTED` - no new product proposal was created nor an existing product from database was assigned to the offer
- - `REMOVED` - the product review was negative or the product was merged with another product. This means that the product will soon be removed from the offer and you can assign a correct product.
-
- AfterSalesServicesProductOfferRequest:
- type: object
- description: The definitions of the different after sales services assigned to the offer.
- properties:
- impliedWarranty:
- allOf:
- - $ref: '#/components/schemas/ImpliedWarranty'
- - type: object
- properties:
- name:
- type: string
- description: The name of the implied warranty definition.
- example: "Implied warranty 1"
- returnPolicy:
- allOf:
- - $ref: '#/components/schemas/ReturnPolicy'
- - type: object
- properties:
- name:
- type: string
- description: The name of the return policy definition.
- example: "Return policy 1"
- warranty:
- allOf:
- - $ref: '#/components/schemas/Warranty'
- - type: object
- properties:
- name:
- type: string
- description: The name of the warranty definition.
- example: "Warranty 1"
- DeliveryProductOfferRequest:
- type: object
- properties:
- handlingTime:
- type: string
- example: PT24H
- description: >-
- Handling time, ISO 8601 duration format.
- This field must be set to one of the following:
- PT0S for immediately, PT24H, P2D, P3D, P4D, P5D, P7D, P10D, P14D, P21D, P30D, P60D.
- shippingRates:
- allOf:
- - $ref: '#/components/schemas/JustId'
- - type: object
- properties:
- name:
- type: string
- description: The name of the shipping rate.
- example: "Shipping rate 1"
- additionalInfo:
- type: string
- maxLength: 650
- deprecated: true
- description: >-
- Additional information about delivery.
- Parameter is deprecated and will be removed in the future.
- Additional information is only visible on marketplace `allegro-pl`.
- example: "Example additional info"
- DeliveryProductOfferResponse:
- type: object
- properties:
- handlingTime:
- type: string
- example: PT24H
- description: >-
- Handling time, ISO 8601 duration format.
- This field must be set to one of the following:
- PT0S for immediately, PT24H, P2D, P3D, P4D, P5D, P7D, P10D, P14D, P21D, P30D, P60D.
- shippingRates:
- $ref: '#/components/schemas/JustId'
- additionalInfo:
- type: string
- maxLength: 650
- deprecated: true
- description: >-
- Additional information about delivery.
- Parameter is deprecated and will be removed in the future.
- Additional information is only visible on marketplace `allegro-pl`.
- example: "Example additional info"
- shipmentDate:
- type: string
- format: date-time
- description: >-
- Shipment date: Format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ.
- example: "2019-08-24T14:15:22Z"
- SaleProductOfferPublicationMarketplacesResponse:
- type: object
- description: >-
- Information about publication in multiple marketplaces.