Allegro REST API

gdzie?
Allegro REST API
Documentation Powered by ReDoc

Allegro REST API (latest)

URL: https://github.com/allegro/allegro-api/issues Terms of Service

https://developer.allegro.pl/about

Documentation is generated from this OpenAPI 3.0 specification file. To start working with our API, you can also check our official Allegro REST API public collection in Postman.

Authentication

bearer-token-for-user

For more information PL / EN to read about authorization code flow or PL / EN 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 PL / EN.

      Security Scheme Type OAuth2
      clientCredentials OAuth Flow
      Token URL: https://allegro.pl/auth/oauth/token
      Scopes:

        User's offer information

        Get all data of the particular product-offer

        Use this resource to retrieve all data of the particular product-offer. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        path Parameters
        offerId
        required
        string

        Offer identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "productSet": [
          ],
        • "category": {
          },
        • "attachments": [
          ],
        • "fundraisingCampaign": {
          },
        • "additionalServices": {
          },
        • "delivery": {
          },
        • "publication": {
          },
        • "additionalMarketplaces": {
          },
        • "b2b": {
          },
        • "compatibilityList": {
          },
        • "language": "pl-PL",
        • "validation": {
          },
        • "warnings": [ ],
        • "afterSalesServices": {
          },
        • "discounts": {
          },
        • "stock": {
          },
        • "parameters": [
          ],
        • "contact": {
          },
        • "createdAt": "2019-08-24T14:15:22Z",
        • "updatedAt": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "payments": {
          },
        • "sellingMode": {
          },
        • "location": {
          },
        • "images": [
          ],
        • "description": {
          },
        • "external": {
          },
        • "sizeTable": {
          },
        • "taxSettings": {
          },
        • "messageToSellerSettings": {
          }
        }

        Get seller's offers

        Use this resource to get the list of the seller's offers. You can use different query parameters to filter the list. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        offer.id
        Array of strings

        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.

        If additionally a publication.marketplace is provided, searches using the price on the given marketplace.

        sellingMode.price.amount.lte
        number >= 1
        Example: sellingMode.price.amount.lte=125.99

        The upper threshold of price.

        If additionally a publication.marketplace is provided, searches using the price on the given marketplace.

        sellingMode.priceAutomation.rule.id
        string

        The ID of price automation rule. Returns offers with given price automation rule ID.

        If additionally a publication.marketplace is provided, searches using the price automation rule on the given marketplace.

        sellingMode.priceAutomation.rule.id.empty
        boolean

        Allows to filter offers by existence of price automation rule ID. Passing 'false' will return offers with any price automation rule, passing 'true' will return offers without any price automation rules.

        If additionally a publication.marketplace is provided, searches using the price automation rule on the given marketplace.

        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: publication.status=INACTIVE&publication.status=ACTIVE - returns offers with status INACTIVE or ACTIVE.

        publication.marketplace
        string (MarketplaceId)
        Example: publication.marketplace=allegro-pl

        Either the base marketplace or an additional marketplace of the offer.

        When passing the parameter publication.marketplace, searches for offers with the given marketplace as either its base marketplace or one of its additional marketplaces. When the parameter is omitted, searches for offers with all marketplaces.

        In addition to searching, passing the parameter also influences the functionality of other query parameter by searching and sorting by data (e.g. price) on the given marketplace.

        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: sellingMode.format=BUY_NOW&sellingMode.format=ADVERTISEMENT - returns offers with with format BUY_NOW or ADVERTISEMENT.

        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: external.id=1233&external.id=1234 - returns offers with ID 1233 or 1234. Single ID length shouldn't exceed 100 characters.

        delivery.shippingRates.id
        string <uuid>

        The ID of shipping rates. Returns offers with given shipping rates ID.

        delivery.shippingRates.id.empty
        boolean

        Allows 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. - prefix means descending order. If you don't provide the sort parameter, the list is sorted by offer creation time, descending.

        If additionally a publication.marketplace is provided, sorts by price and stock.sold using the data on the given marketplace.

        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

        Allows to filter offers by existence of product ID.

        productizationRequired
        boolean

        Allows to search for offers from categories where productization is required.

        b2b.buyableOnlyByBusiness
        boolean

        Allows to search for offers buyable only by businesses.

        fundraisingCampaign.id
        string <uuid>

        ID of the charity fundraising campaign that benefits from this offer.

        fundraisingCampaign.id.empty
        boolean

        Allows to search for charity or commercial offers.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offers": [
          ],
        • "count": 1,
        • "totalCount": 1234
        }

        Get Smart! classification report of the particular offer

        Use this resource to get a full Smart! offer classification report of one of your offers. Please keep in mind you have to meet Smart! seller conditions first - for more details, use GET /sale/smart. To learn more about Smart! offer requirements, see our knowledge base article: PL / EN. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        path Parameters
        offerId
        required
        string

        Offer identifier.

        query Parameters
        marketplaceId
        string
        Example: marketplaceId=allegro-pl

        Marketplace for which offer classification report will be returned. If not specified, the result of the offer's base marketplace will be returned.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "classification": {
          },
        • "scheduledForReclassification": true,
        • "smartDeliveryMethods": [
          ],
        • "conditions": [
          ]
        }

        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.
        • OFFER_VISIBILITY_CHANGED - visibility of offer was changed on marketplaces.

        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:
        bearer-token-for-user (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" "OFFER_VISIBILITY_CHANGED"

        The types of events that will be returned in the response. All types of events are returned by default.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        offer event
        offer event
        offer ended event
        offer bid placed event
        offer bid canceled event
        offer translation updated event
        offer visibility on marketplaces changed event
        {
        • "offerEvents": [
          ]
        }

        Offer management

        Create offer based on product

        Use this resource to create offer based on product. Read more: PL / EN. Note that requests may be limited.

        Authorizations:
        bearer-token-for-user (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.

        required
        object (SaleProductOffersRequestStock)
        object
        object
        object (AdditionalMarketplacesRequest)

        Selected information about the offer in each additional service. This field does not contain information about the base marketplace of the offer.
        Possible values of marketplaceId can be obtained from GET /marketplaces resource.
        See Allegro foreign marketplaces for more details regarding this field.

        object

        For the /sale/product-offers resources you can send only definition of the MANUAL compatibility list. If compatibility list is provided for the product assigned to the offer, it will be used automatically.

        language
        string <BCP-47 language code>

        Declared base language of the offer.

        object

        Category in which the offer is listed for sale. 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 can enter the size tabe identifier or name.

        object

        Identifier of contact data for sales format ADVERTISEMENT (classified ad). You can enter the contact identifier or name.

        object (DiscountsProductOfferRequest)
        name
        string <= 75 characters

        Name (title) of an offer. Length cannot be more than 75 characters. Read more: PL / EN .

        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 (OfferTaxSettings)

        Tax settings for offer. 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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "productSet": [
          ],
        • "b2b": {
          },
        • "attachments": [
          ],
        • "fundraisingCampaign": {
          },
        • "additionalServices": {
          },
        • "stock": {
          },
        • "delivery": {
          },
        • "publication": {
          },
        • "additionalMarketplaces": {
          },
        • "compatibilityList": {
          },
        • "language": "pl-PL",
        • "category": {
          },
        • "parameters": [
          ],
        • "afterSalesServices": {
          },
        • "sizeTable": {
          },
        • "contact": {
          },
        • "discounts": {
          },
        • "name": "string",
        • "payments": {
          },
        • "sellingMode": {
          },
        • "location": {
          },
        • "images": [
          ],
        • "description": {
          },
        • "external": {
          },
        • "taxSettings": {
          },
        • "messageToSellerSettings": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "productSet": [
          ],
        • "category": {
          },
        • "attachments": [
          ],
        • "fundraisingCampaign": {
          },
        • "additionalServices": {
          },
        • "delivery": {
          },
        • "publication": {
          },
        • "additionalMarketplaces": {
          },
        • "b2b": {
          },
        • "compatibilityList": {
          },
        • "language": "pl-PL",
        • "validation": {
          },
        • "warnings": [ ],
        • "afterSalesServices": {
          },
        • "discounts": {
          },
        • "stock": {
          },
        • "parameters": [
          ],
        • "contact": {
          },
        • "createdAt": "2019-08-24T14:15:22Z",
        • "updatedAt": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "payments": {
          },
        • "sellingMode": {
          },
        • "location": {
          },
        • "images": [
          ],
        • "description": {
          },
        • "external": {
          },
        • "sizeTable": {
          },
        • "taxSettings": {
          },
        • "messageToSellerSettings": {
          }
        }

        Edit an offer

        Use this resource to edit offer. Read more: PL / EN. Note that requests may be limited.

        Authorizations:
        bearer-token-for-user
        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 /sale/product-offers resources you can send only definition of the MANUAL compatibility list. If compatibility list is provided for the product assigned to the offer, it will be used automatically.

        object
        object (SaleProductOffersRequestStock)
        object
        object (AdditionalMarketplacesRequest)

        Selected information about the offer in each additional service. This field does not contain information about the base marketplace of the offer.
        Possible values of marketplaceId can be obtained from GET /marketplaces resource.
        See Allegro foreign marketplaces for more details regarding this field.

        language
        string <BCP-47 language code>

        Declared base language of the offer.

        object

        Category in which the offer is listed for sale. 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 can enter the size tabe identifier or name.

        object

        Identifier of contact data for sales format ADVERTISEMENT (classified ad). You can enter the contact identifier or name.

        object (DiscountsProductOfferRequest)
        name
        string <= 75 characters

        Name (title) of an offer. Length cannot be more than 75 characters. Read more: PL / EN .

        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 (OfferTaxSettings)

        Tax settings for offer. 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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "productSet": [
          ],
        • "b2b": {
          },
        • "attachments": [
          ],
        • "fundraisingCampaign": {
          },
        • "additionalServices": {
          },
        • "compatibilityList": {
          },
        • "delivery": {
          },
        • "stock": {
          },
        • "publication": {
          },
        • "additionalMarketplaces": {
          },
        • "language": "pl-PL",
        • "category": {
          },
        • "parameters": [
          ],
        • "afterSalesServices": {
          },
        • "sizeTable": {
          },
        • "contact": {
          },
        • "discounts": {
          },
        • "name": "string",
        • "payments": {
          },
        • "sellingMode": {
          },
        • "location": {
          },
        • "images": [
          ],
        • "description": {
          },
        • "external": {
          },
        • "taxSettings": {
          },
        • "messageToSellerSettings": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "productSet": [
          ],
        • "category": {
          },
        • "attachments": [
          ],
        • "fundraisingCampaign": {
          },
        • "additionalServices": {
          },
        • "delivery": {
          },
        • "publication": {
          },
        • "additionalMarketplaces": {
          },
        • "b2b": {
          },
        • "compatibilityList": {
          },
        • "language": "pl-PL",
        • "validation": {
          },
        • "warnings": [ ],
        • "afterSalesServices": {
          },
        • "discounts": {
          },
        • "stock": {
          },
        • "parameters": [
          ],
        • "contact": {
          },
        • "createdAt": "2019-08-24T14:15:22Z",
        • "updatedAt": "2019-08-24T14:15:22Z",
        • "name": "string",
        • "payments": {
          },
        • "sellingMode": {
          },
        • "location": {
          },
        • "images": [
          ],
        • "description": {
          },
        • "external": {
          },
        • "sizeTable": {
          },
        • "taxSettings": {
          },
        • "messageToSellerSettings": {
          }
        }

        Check the processing status of a POST or PATCH request

        The URI for the resource given by Location header of POST /sale/product-offers and PATCH /sale/product-offers/{offerId}. Use this resource to check processing status of a POST or PATCH request. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offer": {
          },
        • "operation": {
          }
        }

        Delete a draft offer

        Use this resource to delete a draft offer. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        offerId
        required
        string

        Offer identifier.

        Responses

        Modify the Buy Now price in an offer

        Use this resource to change the Buy Now price in a single offer. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "6365996a-6cae-11e9-a923-1681be663d3e",
        • "input": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "6365996a-6cae-11e9-a923-1681be663d3e",
        • "input": {
          },
        • "output": {
          }
        }

        Batch offer publish / unpublish

        Use this resource to modify multiple offers publication at once. Read more: PL / EN. This resource is rate limited to 250 000 offer changes per hour or 9000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offerCriteria": [
          ],
        • "publication": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "taskCount": {
          }
        }

        Publish command summary

        Use this resource to retrieve information about the offer listing statuses. You will receive a summary with a number of correctly listed offers and errors. Read more: PL / EN. This resource is rate limited to retrieving information about 270 000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "taskCount": {
          }
        }

        Publish command detailed report

        Use this resource to retrieve information about the offer statuses on the site (Defaults: limit = 100, offset = 0). Read more: PL / EN. This resource is rate limited to retrieving information about 270 000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "tasks": [
          ]
        }

        Get all available offer promotion packages

        Use this resource to retrieve all available offer promotion packages. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "marketplaceId": "allegro-pl",
        • "basePackages": [
          ],
        • "extraPackages": [
          ],
        • "additionalMarketplaces": [
          ]
        }

        Modify offer promotion packages

        Use this resource to modify offer promotion packages. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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.

        Array of objects (AdditionalMarketplacePromoOptionsModification) [ items ]

        Promo package modifications to be applied on additional marketplaces.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "modifications": [
          ],
        • "additionalMarketplaces": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offerId": "9991337999",
        • "marketplaceId": "allegro-pl",
        • "basePackage": {
          },
        • "extraPackages": [
          ],
        • "pendingChanges": {
          },
        • "additionalMarketplaces": [
          ]
        }

        Get offer promotion packages

        Use this resource to get promotion packages assigned to an offer. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        path Parameters
        offerId
        required
        string
        Example: 9991337999

        Offer identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offerId": "9991337999",
        • "marketplaceId": "allegro-pl",
        • "basePackage": {
          },
        • "extraPackages": [
          ],
        • "pendingChanges": {
          },
        • "additionalMarketplaces": [
          ]
        }

        Get promo options for seller's offers

        Use this resource to retrieve promo options for seller offers. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "promoOptions": [
          ],
        • "count": 3,
        • "totalCount": 256
        }

        Batch offer promotion package modification

        Use this resource to modify promotion packages on multiple offers at once. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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)
        Array of objects (AdditionalMarketplacePromoOptionsCommandModification) [ items ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offerCriteria": [
          ],
        • "modification": {
          },
        • "additionalMarketplaces": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "taskCount": {
          }
        }

        Modification command summary

        Use this resource to find out how many offers were edited within one {commandId}. You will receive a summary with a number of successfully edited offers and errors. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "taskCount": {
          }
        }

        Modification command detailed result

        Use this resource to retrieve the result of an offer modification command. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "tasks": [
          ],
        • "modification": {
          },
        • "additionalMarketplaces": [
          ]
        }

        Get offers with missing parameters

        Use this resource to get information about required parameters or parameters scheduled to become required that are not filled in offers. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offers": [
          ],
        • "count": 3,
        • "totalCount": 256
        }

        Offer translations

        Get offer translations

        Get offer translation for given language or all present. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "translations": [
          ]
        }

        Update offer translation

        Update manual translation for offer. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "description": {
          },
        • "title": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "error": "unauthorized",
        • "error_description": "Full authentication is required to access this resource"
        }

        Delete offer translation

        Delete single element or entire manual translation. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "error": "unauthorized",
        • "error_description": "Full authentication is required to access this resource"
        }

        Categories and parameters

        Get IDs of Allegro categories

        Use this resource to traverse the Allegro categories tree. It returns the list of the given category's children or a list of the main Allegro categories. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "categories": [
          ]
        }

        Get a category by ID

        Use this resource to get the details of a specific category. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        path Parameters
        categoryId
        required
        string
        Example: 6061

        The category ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "12",
        • "leaf": true,
        • "name": "Pozostałe",
        • "options": {
          },
        • "parent": {
          }
        }

        Get parameters supported by a category

        Use this resource to get the list of parameters that are supported by the given category. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        path Parameters
        categoryId
        required
        string
        Example: 709

        The category ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Integer
        Integer
        String single
        Dictionary
        Float
        Float range
        {
        • "parameters": [
          ]
        }

        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:
        bearer-token-for-applicationbearer-token-for-user
        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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "scheduledChanges": [
          ]
        }

        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.

        Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        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

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Category created event
        Category created event
        Category renamed event
        Category moved event
        Category deleted event
        {
        • "events": [
          ]
        }

        Get categories suggestions

        Use this resource to receive suggested categories for given phrase. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        query Parameters
        name
        required
        string
        Example: name=bmw x3

        Product name for which you want to get suggested categories.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "matchingCategories": [
          ]
        }

        Images and attachments

        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.

        Read more: PL / EN. More information about rules for photos in an offer's gallery and description you will find here.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        Request Body schema:
        application/vnd.allegro.public.v1+json
        application/vnd.allegro.public.v1+json
        image/jpeg
        image/png
        image/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

        Content type
        application/vnd.allegro.public.v1+json
        application/vnd.allegro.public.v1+json
        image/jpeg
        image/png
        image/webp
        {
        • "url": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "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). Allowed media types: PDF
        • Special offer terms (SPECIAL_OFFER_RULES). Allowed media types: PDF
        • Competition terms (COMPETITION_RULES). Allowed media types: PDF
        • Book excerpt (BOOK_EXCERPT). Allowed media types: PDF
        • Manual (USER_MANUAL). Allowed media types: PDF
        • Installation manual (INSTALLATION_INSTRUCTIONS). Allowed media types: PDF
        • Game manual (GAME_INSTRUCTIONS). Allowed media types: PDF
        • Energy label (ENERGY_LABEL). Allowed media types: JPEG, JPG, PNG
        • Product information sheet (PRODUCT_INFORMATION_SHEET). Allowed media types: PDF
        • Tire label (TIRE_LABEL). Allowed media types: JPEG, JPG, PNG

        You can attach up to 20 files to one product for:

        • Safety information manual (SAFETY_INFORMATION_MANUAL). Allowed media types: PDF, JPEG, JPG, PNG

        Uploading attachments flow:

        1. Create an attachment object to receive an upload URL (POST /sale/offer-attachments),
        2. Use the upload URL to submit the file (PUT /sale/offer-attachments/{attachmentId}),
        3. Add attachments to the offer (PATCH /sale/product-offers/{offerId}).

        Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (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" "TIRE_LABEL" "SAFETY_INFORMATION_MANUAL"

        offer attachment type

        object (AttachmentFileRequest)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "type": "MANUAL",
        • "file": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "type": "MANUAL",
        • "file": {
          }
        }

        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:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        attachmentId
        required
        string <uuid>

        The ID of the attachment.

        Request Body schema:
        application/pdf
        application/pdf
        image/jpeg
        image/png
        string <binary>

        File in a binary format

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "type": "MANUAL",
        • "file": {
          }
        }

        Products

        Get product parameters available in given category

        Use this resource to get the list of product parameters available in given category. You can use these parameters to create a new product. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        path Parameters
        categoryId
        required
        string
        Example: 709

        The category ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Integer
        Integer
        String single
        Dictionary
        Float
        Float range
        {
        • "parameters": [
          ]
        }

        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, read more PL / EN.

        Authorizations:
        bearer-token-for-user (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 (GTIN) parameters instead.

        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.

        • 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).
        language
        string <BCP-47 language code>
        Example: language=en-US

        Language indicates the language for searching products. Allows to specify the language of the given phrase. At present we support: "pl-PL" and "cs-CZ".

        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:

        {
  "id": "127448",
  "name": "Kolor",
  "type": "SINGLE",
  "values": [
    {
      "name": "biały",
      "value": "127448_2"
    },
    {
      "name": "czarny",
      "value": "127448_1"
    }
  ]
}

        You can use 'Kolor' filter to query results, i.e.:

        • 127448=127448_2 for "biały"
        • 127448=127448_1 for "czarny".
        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).

        includeDrafts
        boolean

        Include products in draft state.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "products": [
          ],
        • "categories": {
          },
        • "filters": [
          ],
        • "nextPage": {
          }
        }

        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:
        bearer-token-for-user (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.

        includeDrafts
        boolean

        Return also if product is in draft state.

        language
        string <BCP-47 language code>
        Example: language=en-US

        The language version of product. You can indicate the language for the returned product data. At present we support: "pl-PL", "cs-CZ", "en-US" and "uk-UA".

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
        • "name": "iPhone 5s",
        • "category": {
          },
        • "images": [
          ],
        • "parameters": [
          ],
        • "offerRequirements": {
          },
        • "compatibilityList": {
          },
        • "tecdocSpecification": {
          },
        • "description": {
          },
        • "isDraft": true,
        • "aiCoCreatedContent": {
          },
        • "hasProtectedBrand": true,
        • "publication": {
          },
        • "productSafety": {
          }
        }

        Propose a product

        Use this resource to propose a product. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        name
        required
        string <= 75 characters

        Suggested product name.

        required
        object (ProductCategory)

        Product category

        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.

        language
        required
        string <BCP-47 language code>

        Language of provided product data (name, description, parameters's values).

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "iPhone 5s",
        • "category": {
          },
        • "images": [
          ],
        • "parameters": [
          ],
        • "description": {
          },
        • "language": "pl-PL"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "c9e39cae-9cb6-11e9-a2a3-2a2ae2dbcce4",
        • "name": "iPhone 5s",
        • "category": {
          },
        • "images": [
          ],
        • "parameters": [
          ],
        • "description": {
          },
        • "supplier": {
          },
        • "offerId": "string",
        • "language": "pl-PL",
        • "publication": {
          }
        }

        Propose changes in product

        Use this resource to propose changes in product. Read more: PL / EN. This resource is limited to 100 suggestions per day for a single user.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        productId
        required
        string

        The product identifier.

        header Parameters
        Accept-Language
        string <BCP-47 language code>
        Default: en-US
        Example: pl-PL

        Expected language of messages.

        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 (ProductCategory)

        Product category

        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.

        language
        required
        string <BCP-47 language code>
        Default: "pl-PL"

        Language of provided proposal data.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "iPhone 5s",
        • "note": "Some additional note to product changes proposal.",
        • "category": {
          },
        • "images": [
          ],
        • "parameters": [
          ],
        • "notifyViaEmailAfterVerification": true,
        • "language": "pl-PL"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": {
          },
        • "category": {
          },
        • "note": "Some additional note to product changes proposal.",
        • "images": [
          ],
        • "parameters": [
          ],
        • "notifyViaEmailAfterVerification": true,
        • "language": "string"
        }

        Get all data of the particular product changes proposal

        Use this resource to retrieve all data of the particular product changes proposal. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        path Parameters
        changeProposalId
        required
        string

        The product changes proposal identifier.

        header Parameters
        Accept-Language
        string <BCP-47 language code>
        Default: en-US
        Example: pl-PL

        Expected language of messages.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": {
          },
        • "category": {
          },
        • "note": "Some additional note to product changes proposal.",
        • "images": [
          ],
        • "parameters": [
          ],
        • "notifyViaEmailAfterVerification": true,
        • "language": "string"
        }

        Batch offer modification

        Batch offer modification

        Use this resource to modify multiple offers at once. Read more: PL / EN. This resource is rate limited to 250 000 offer changes per hour or 9000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Request Body schema: application/vnd.allegro.public.v1+json

        offerChangeCommandDto

        object (Modification)

        Contains fields to change

        Array of objects (OfferCriterium) [ items ]

        List of offer criteria

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "modification": {
          },
        • "offerCriteria": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "taskCount": {
          }
        }

        Modification command summary

        Use this resource to find out how many offers were edited within one {commandId}. You will receive a summary with a number of successfully edited offers. Read more: PL / EN. This resource is rate limited to retrieving information about 270 000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "taskCount": {
          }
        }

        Modification command detailed report

        Use this resource to retrieve a detailed summary of changes introduced within one {commandId} (defaults: limit = 100, offset = 0). Read more: PL / EN. This resource is rate limited to retrieving information about 270 000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "tasks": [
          ]
        }

        Batch offer price modification

        Change price of offers. Read more: PL / EN. This resource is rate limited to 250 000 offer changes per hour or 9000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Request Body schema: application/vnd.allegro.public.v1+json

        offerPriceChangeCommandDto

        object (PriceModification)

        The way the offer price should be changed. One of three ways is possible: new price, increase/decrease price, percentage change and only one can be chosen at once.

        Array of objects (OfferCriterium) [ items ]

        List of offer criteria

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "modification": {
          },
        • "offerCriteria": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "taskCount": {
          }
        }

        Change price command summary

        Returns status and summary of particular command execution. Read more: PL / EN. This resource is rate limited to retrieving information about 270 000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "completedAt": "2019-08-24T14:15:22Z",
        • "taskCount": {
          }
        }

        Change price command detailed report

        Defaults: limit = 100, offset = 0. Read more: PL / EN. This resource is rate limited to retrieving information about 270 000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (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

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "tasks": [
          ]
        }

        Batch offer quantity modification

        Change quantity of multiple offers. Read more: PL / EN. This resource is rate limited to 250 000 offer changes per hour or 9000 offer changes per minute.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        commandId
        required
        string

        Command identifier.

        Request Body schema: application/vnd.allegro.public.v1+json

        offerQuantityChangeCommandDto

        object (QuantityModification)

        The way the offer quantity should be changed. One of two ways is possible: new quantity, increase/decrease quantity and only one can be chosen at once.

        Array of objects (OfferCriterium) [ items ]

        List of offer criteria

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "modification": {