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.

        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": {
          }
        }

        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": {
          },
        • "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 quantity command summary

        Returns status and summary of the command. 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 quantity 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 automatic pricing rules modification

        Use this resource to modify the automatic pricing rules of multiple offers at the same time. 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)
        Request Body schema: application/vnd.allegro.public.v1+json

        OfferAutomaticPricingCommand

        id
        string <uuid>

        The Command identifier. This field is optional. If the client does not provide their own command id then the service will generate a command id and return it in the response.

        required
        OfferAutomaticPricingModificationSet (object) or OfferAutomaticPricingModificationRemove (object)
        required
        Array of objects (OfferCriterium) [ items ]

        List of offer criteria.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "123a08d7-ab9b-460d-b9cb-d6ed64b3a018",
        • "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": {
          }
        }

        Automatic pricing command summary

        Returns status and summary of the offer-price-automation-command. 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:read)
        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": {
          }
        }

        Automatic pricing command detailed report

        Defaults: limit = 100, offset = 0. Returns status and report of the offer-price-automation-command. 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:read)
        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": [
          ]
        }

        Automatic pricing

        Get automatic pricing rules

        Use this resource to get automatic pricing rules. Rules with property default set to true are default rules created by Allegro for each merchant. This resource is rate limited to 5 requests per second.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)

        Responses

        Response samples

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

        Post automatic pricing rule

        Use this resource to create automatic pricing rule. This resource is rate limited to 5 requests per second.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        The automatic pricing rule.

        name
        required
        string (AutomaticPricingRuleName) <= 33 characters

        The rule name. Default rule names are automatically translated based on the value provided in the the "Accept-Language" header.

        type
        required
        string (AutomaticPricingRuleType)
        Enum: "EXCHANGE_RATE" "FOLLOW_BY_ALLEGRO_MIN_PRICE" "FOLLOW_BY_MARKET_MIN_PRICE"

        The rule type.

        • EXCHANGE_RATE - Calculates prices on additional marketplaces using the latest exchange rates and price from the offer base marketplace.
          Is not available on base marketplace and business marketplaces.
          More information about EXCHANGE_RATE type.
        • FOLLOW_BY_ALLEGRO_MIN_PRICE - Calculates prices by following the lowest product price on Allegro for a given marketplace.
          Is not available on business marketplaces.
          More information about FOLLOW_BY_ALLEGRO_MIN_PRICE type.
        • FOLLOW_BY_MARKET_MIN_PRICE - Calculates prices by following the lowest product price on market for a given marketplace.
          Is not available on business marketplaces.
        required
        object (AutomaticPricingRuleConfiguration)

        Rule configuration. This field is optional.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "Lowest price on Allegro plus 10%",
        • "type": "FOLLOW_BY_ALLEGRO_MIN_PRICE",
        • "configuration": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "641c73feaef0a8281a3d11f8",
        • "type": "FOLLOW_BY_ALLEGRO_MIN_PRICE",
        • "name": "Lowest price on Allegro plus 10%",
        • "default": false,
        • "configuration": {
          },
        • "updatedAt": "2023-03-23T15:45:02Z"
        }

        Get automatic pricing rule by id

        Use this resource to get automatic pricing rule by id. Rules with property default set to true are default rules created by Allegro for each merchant and cannot be modified. This resource is rate limited to 5 requests per second.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        path Parameters
        ruleId
        required
        string
        Example: 66466e2b07ba0029b829f08d

        The rule identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "641c73feaef0a8281a3d11f8",
        • "type": "FOLLOW_BY_ALLEGRO_MIN_PRICE",
        • "name": "Lowest price on Allegro plus 10%",
        • "default": false,
        • "configuration": {
          },
        • "updatedAt": "2023-03-23T15:45:02Z"
        }

        Edit automatic pricing rule

        Use this resource to update automatic pricing rule. This resource is rate limited to 5 requests per second.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        ruleId
        required
        string
        Example: 66466e2b07ba0029b829f08d

        The rule identifier.

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

        The automatic pricing rule.

        name
        required
        string (AutomaticPricingRuleName) <= 33 characters

        The rule name. Default rule names are automatically translated based on the value provided in the the "Accept-Language" header.

        required
        object (AutomaticPricingRuleConfiguration)

        Rule configuration. This field is optional.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "Lowest price on Allegro plus 10%",
        • "configuration": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "641c73feaef0a8281a3d11f8",
        • "type": "FOLLOW_BY_ALLEGRO_MIN_PRICE",
        • "name": "Lowest price on Allegro plus 10%",
        • "default": false,
        • "configuration": {
          },
        • "updatedAt": "2023-03-23T15:45:02Z"
        }

        Delete automatic pricing rule

        Use this resource to delete automatic pricing rule. This resource is rate limited to 5 requests per second.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        path Parameters
        ruleId
        required
        string
        Example: 66466e2b07ba0029b829f08d

        The rule identifier.

        Responses

        Get automatic pricing rules assigned to the offer

        Use this resource to get automatic pricing rules for offer. This resource is rate limited to 5 requests per second.

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

        The offer identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "rules": [
          ],
        • "updatedAt": "2023-03-23T15:45:02Z"
        }

        Offer variants

        Create variant set

        Use this resource to create variant set.

        A valid variant set must consist of three required elements:

        • name:
          • it can't be blank and must not be longer than 75 characters
        • parameters:
          • it should contain parameter identifiers used for offer grouping
          • parameter identifiers from the offers and special color/pattern value (for grouping via image) are permitted
          • it must contain at least one element (up to 2)
        • offers:
          • it must contain at least 2 offers (500 at most)
          • colorPattern value must be set for every offer if color/pattern parameter is used
          • colorPattern value can't be blank and must not be longer than 50 characters
          • colorPattern can take arbitrary string value like red, b323592c-522f-4ec1-b9ea-3764538e0ac4 (UUID), etc.
          • offers having the same image should have identical colorPattern value
          • offers must have publication.marketplaces.base equal to allegro-pl

        Let's assume we have 4 offers:

        • offer with id 2 having an image of a red t-shirt and S as a value of parameter with id 21
        • offer with id 3 having an image of a red t-shirt and M as a value of parameter with id 21
        • offer with id 4 having an image of a blue t-shirt and S as a value of parameter with id 21
        • offer with id 5 having an image of a blue t-shirt and M as a value of parameter with id 21

        You can build a variant set by grouping offers using combination of available parameters - examples are available in Request samples.

        More general information about variant sets can be found here. Read more: PL / EN.

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

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        offer parameter only
        offer parameter only
        color/pattern parameter only
        offer and color/pattern parameters
        {
        • "name": "t-shirt",
        • "offers": [
          ],
        • "parameters": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "offers": [
          ],
        • "name": "string",
        • "parameters": [
          ]
        }

        Get the user's variant sets

        Use this resource to get created variant sets. The returned variant sets are ordered by name. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        offset
        integer [ 0 .. 9950 ]
        Default: 0

        Index of first returned variant set.

        limit
        integer [ 1 .. 50 ]
        Default: 10

        Maximum number of returned variant sets.

        query
        string <= 50 characters

        Filter variant sets by name or offer id.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "count": 10,
        • "offerVariants": [
          ]
        }

        Update variant set

        Use this resource to edit variant set.

        A valid variant set must consist of three required elements:

        • name:
          • it can't be blank and must not be longer than 75 characters
        • parameters:
          • it should contain parameter identifiers used for offer grouping
          • parameter identifiers from the offers and special color/pattern value (for grouping via image) are permitted
          • it must contain at least one element (up to 2)
        • offers:
          • it must contain at least 2 offers (500 at most)
          • colorPattern value must be set for every offer if color/pattern parameter is used
          • colorPattern value can't be blank and must not be longer than 50 characters
          • colorPattern can take arbitrary string value like red, b323592c-522f-4ec1-b9ea-3764538e0ac4 (UUID), etc.
          • offers having the same image should have identical colorPattern value
          • offers must have publication.marketplaces.base equal to allegro-pl

        Let's assume we have 4 offers:

        • offer with id 2 having an image of a red t-shirt and S as a value of parameter with id 21
        • offer with id 3 having an image of a red t-shirt and M as a value of parameter with id 21
        • offer with id 4 having an image of a blue t-shirt and S as a value of parameter with id 21
        • offer with id 5 having an image of a blue t-shirt and M as a value of parameter with id 21

        You can build a variant set by grouping offers using combination of available parameters - examples are available in Request samples.

        More general information about variant sets can be found here. Read more: PL / EN.

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

        Variant set identifier.

        Request Body schema: application/vnd.allegro.public.v1+json
        required
        Array of objects (VariantSet_Offer) [ items ]
        name
        required
        string <= 75 characters
        required
        Array of objects (VariantSet_Parameter) [ items ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        offer parameter only
        offer parameter only
        color/pattern parameter only
        offer and color/pattern parameters
        {
        • "name": "t-shirt",
        • "offers": [
          ],
        • "parameters": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "offers": [
          ],
        • "name": "string",
        • "parameters": [
          ]
        }

        Get a variant set

        Use this resource to get variant set by set id. Read more: PL / EN.

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

        Variant set identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "offers": [
          ],
        • "name": "string",
        • "parameters": [
          ]
        }

        Delete a variant set

        Use this resource to delete variant set by id. Offers included in variant set will not be stopped or modified by this operation. Read more: PL / EN.

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

        Variant set identifier.

        Responses

        Offer tags

        Tags are only available to sellers registered on allegro.pl and can only be assigned to offers with base marketplace allegro-pl.

        Create a tag

        Use this resource to create a new tag. You can create up to 100 tags. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        request

        name
        required
        string [ 1 .. 25 ] characters
        hidden
        boolean

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "hidden": true
        }

        Response samples

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

        Get the user's tags

        Use this resource to get a list of tags defined by the specified user (Defaults: limit = 1000, offset = 0). Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 1000 ]
        Default: 1000

        The limit of elements in the response.

        offset
        integer <int32> >= 0
        Default: 0

        The offset of elements in the response.

        Responses

        Response samples

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

        Delete a tag

        Use this resource to delete the tag. Read more: PL / EN.

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

        Tag identifier.

        Responses

        Response samples

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

        Modify a tag

        Use this resource to update a tag. Read more: PL / EN. This resource is rate limited to 1 million changes per hour.

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

        Tag identifier.

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

        request

        name
        required
        string [ 1 .. 25 ] characters
        hidden
        boolean

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "hidden": true
        }

        Response samples

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

        Assign tags to an offer

        Use this resource to assign a tag to offer. Read more: PL / EN.

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

        Offer identifier.

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

        request

        required
        Array of objects (TagId) [ items ]

        Responses

        Request samples

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

        Response samples

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

        Get tags assigned to an offer

        Use this resource to get a list of tags assigned to 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
        {
        • "tags": [
          ]
        }

        Tax settings

        Get all tax settings for category

        Use this resource to receive tax settings for given category. Based on received settings you may set VAT tax settings for your offers. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        query Parameters
        category.id
        required
        string
        Example: category.id=316194

        An identifier of a category for which all available tax settings will be returned.

        countryCode
        Array of strings
        Items Enum: "PL" "CZ" "SK" "HU"
        Example: countryCode=PL

        Country code for which tax settings will be returned. If not provided settings for all countries will be returned.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        application/vnd.allegro.public.v1+json
        application/vnd.allegro.beta.v1+json
        {
        • "subjects": [
          ],
        • "rates": [
          ],
        • "exemptions": [
          ]
        }

        Compatibility List

        Get list of categories where compatibility list is supported

        Compatibility list is available in particular categories, this resource allows to get the list of these categories with additional details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)

        Responses

        Response samples

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

        Get suggested compatibility list.

        Resource allows to fetch compatibility list suggestion for given offer or product. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        query Parameters
        offer.id
        string

        Offer id on the basis of which we will return the suggested compatibility list.

        product.id
        string

        Product id on the basis of which we will return the suggested compatibility list.

        language
        string
        Example: language=pl-PL

        Locale on the basis of which we will return the suggested compatibility list. For product-based suggestions if missing pl-PL will be used. For offer-based suggestions if missing offer language will be used.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        MANUAL
        MANUAL
        PRODUCT_BASED
        CompatibilityListProductBasedProductOfferResponse
        {
        • "type": "MANUAL",
        • "items": [
          ]
        }

        Get list of compatible product groups

        Compatible products are organized in groups, this resource allows to browse these groups. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        type
        required
        string
        Example: type=CAR

        Type of compatible products. You can find available types in the response for the GET supported-categories resource. You can use value provided in itemsType, for categories where inputType=ID.

        limit
        integer [ 1 .. 200 ]
        Default: 200

        The limit of returned items.

        offset
        integer >= 0
        Default: 0

        The offset of returned items.

        header Parameters
        If-Modified-Since
        string <<day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT>
        Example: Sat, 01 Dec 2018 10:00:00 GMT

        Date of last data modification. If data has been modified after specified date, full set of data is returned. If header is not specified, full set of data is returned. Date has to be provided in HTTP-date format.

        Responses

        Response samples

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

        Get list of compatible products

        Resource allows to fetch compatible products of given type. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        type
        required
        string
        Example: type=CAR

        Type of compatible products. You can find available types in the response for the GET supported-categories resource. You can use value provided in itemsType, for categories where inputType=ID.

        group.id
        string

        Group identifier from /sale/compatible-products/groups resource. Parameter is required when parameter tecdoc.kTypNr or tecdoc.nTypNr or phrase is not specified.

        tecdoc.kTypNr
        string

        Identifier of passenger vehicle (kTypNr) from TecDoc database. When used, group.id parameter is ignored.

        tecdoc.nTypNr
        string

        Identifier of commercial vehicle (nTypNr) from TecDoc database. When used, group.id parameter is ignored.

        phrase
        string

        Query for compatible products. When used, parameters: group.id, limit, offset and header If-Modified-Since are ignored.

        limit
        integer [ 1 .. 200 ]
        Default: 200

        The limit of returned items. If phrase parameter is present, parameter is ignored and maximum value is set to 200.

        offset
        integer >= 0
        Default: 0

        The offset of returned items. If phrase parameter is present, parameter is ignored.

        header Parameters
        If-Modified-Since
        string <<day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT>
        Example: Sat, 01 Dec 2018 10:00:00 GMT

        Date of last data modification. If data has been modified after specified date, full set of data is returned. If header is not specified, full set of data is returned. Date has to be provided in HTTP-date format. Header is ignored if phrase parameter is used.

        Responses

        Response samples

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

        Rebates and promotions

        Create a new promotion

        This endpoint creates a new promotion. You can create promotions only if your base marketplace is allegro-pl. Created promotions are visible only on the allegro-pl marketplace. You can define the following types of promotions:

        1. Large order discount
          Only company users will see and be eligible for this type of promotion. In order to create a large order discount, you also have to be a company user. Furthermore, you are allowed to have only one active order discount at a time. Define a promotion with a single benefit of type LARGE_ORDER_DISCOUNT and a single criterion of type ALL_OFFERS. The benefit specification should contain a list of order value based discount thresholds. Threshold's order value defines the minimum total value of an order for which the threshold is applicable (lowerBound). Threshold's discount defines the discount percentage applied when the threshold is applied. The percentage's fractional part must be equal to 0. Only the highest applicable threshold (if any) will be applied to the total value of the order. A threshold with a higher order value than another threshold in the order discount must also have a higher discount. Large order discount is assigned automatically to all seller's offers. Moreover, it will be assigned to all newly added seller's offers once activated. Please note that it may take some time to propagate this type of promotion to all of your offers. Read more: PL / EN.

        2. Wholesale price list
          Only company users will see and be eligible for this type of promotion. In order to create a wholesale price list, you also have to be a company user. Define a promotion with a single benefit of type WHOLESALE_PRICE_LIST and a single criterion of type OFFERS_ASSIGNED_EXTERNALLY. The benefit specification should contain a name (it will be visible to you only) and a list of quantity based discount thresholds. Threshold's quantity defines the minimum number of units of an offer for which the threshold is applicable (lowerBound). Threshold's discount defines the discount percentage applied when the threshold is applied. The percentage's fractional part must be equal to 0. Only the highest applicable threshold (if any) will be applied to the total price of units of the offer bought. A threshold with a higher quantity than another threshold in the price list must also have a higher discount. In order to assign offers to a wholesale price list, use discounts field in batch offer modification. Read more: PL / EN.

        3. Bundle

          Creating offer bundles via this endpoint is deprecated. Please migrate to /sale/bundles endpoint which is dedicated for bundles.


          In order to create a new bundle, you have to define a promotion with a single benefit of type ORDER_FIXED_DISCOUNT and a single criterion of type CONTAINS_OFFERS. In the benefit specification you have to declare the discount amount that you want to be deducted from the sum of bundled offers prices. In the offer criterion you need to pass a list of offers that are to be grouped as a bundle. For each offer you have to define a fixed quantity (that many pieces of your offer will be part of the bundle) and you also have to set a promotionEntryPoint flag (offers with this flag set to true will have a section that allows the users to purchase your bundle). Read more: PL / EN

        4. Multipack
          In order to create a new multipack, you have to define a promotion with a single benefit of type UNIT_PERCENTAGE_DISCOUNT and a single criterion of type CONTAINS_OFFERS. The benefit specification should contain a configuration section with a percentage which indicates the specific discount for the discounted offer. This percentage should be an integer value greater than 15 for quantity 2, greater than 30 for quantity 3, greater than 40 for quantity 4, greater than 50 for quantity 5 and lower than or equal to 100. The specification should also contain a trigger section with a field forEachQuantity that defines the amount of items in the multipack which is necessary to trigger the benefit. Additionally, the discountedNumber field must be set to 1 by default as you can only discount one unit in a multipack. Finally, the offer criterion specifies the offer for which the multipack promotion will take effect. Read more: PL / EN

        5. Cross-offer multipack
          A cross-offer multipack is created in the same fashion as a standard multipack. The only difference is that you need to pass more than 1 offer in the offer criterion section. This group of offers is then considered as a pool from which users can pick and choose forEachQuantity offers and the cheapest of them gets a discount.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        required
        Array of objects (Benefit) [ items ]

        What kind of rebate will be given

        required
        Array of objects (SellerRebateOfferCriterion) [ items ]

        What offers will be included

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Large Order Discount
        Large Order Discount
        Wholesale Price List
        Bundle
        Multipack
        Cross-offer Multipack
        {
        • "benefits": [
          ],
        • "offerCriteria": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Large Order Discount
        Large Order Discount
        Wholesale Price List
        Bundle
        Multipack
        Cross-offer Multipack
        {
        • "status": "ACTIVE",
        • "createdAt": "2019-05-12T10:02:31.123Z",
        • "id": "72c40ffb-6127-4719-a473-867bf5775601",
        • "benefits": [
          ],
        • "offerCriteria": [
          ]
        }

        Get the user's list of promotions

        Get a list of promotions defined by the authorized user and filtered by promotion type.
        Listing offer bundles via this endpoint is deprecated. Please migrate to /sale/bundles endpoint which is dedicated for bundles.

        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, Bundles and Multipack PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 5000 ]
        Default: 50

        Limit of promotions per page.

        offset
        integer <int32> [ 0 .. 49999 ]
        Default: 0

        Distance between the beginning of the document and the point from which promotions are returned.

        offer.id
        string
        Example: offer.id=8226673525

        Filter by offer id. No promotions with OFFERS_ASSIGNED_EXTERNALLY or ALL_OFFERS criteria will be returned if this parameter is present.

        promotionType
        required
        string
        Enum: "BUNDLE" "MULTIPACK" "CROSS_MULTIPACK" "LARGE_ORDER_DISCOUNT" "WHOLESALE_PRICE_LIST"

        Filter by promotion type.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "promotions": [
          ],
        • "totalCount": 0
        }

        Get a promotion data by id


        Use this resource to return the requested promotion. You need to use its unique id.
        Getting offer bundle via this endpoint is deprecated. Please migrate to /sale/bundles/{bundleId} endpoint which is dedicated for bundles.
        Read more about: Large order discount PL / EN, Wholesale price list PL / EN, Bundles PL / EN, Multipack PL / EN.

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

        Promotion identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "benefits": [
          ],
        • "createdAt": "2019-05-01T10:12:32.321Z",
        • "id": "7c9a76d3-9fd0-4d13-a4ce-5d49bec12c79",
        • "offerCriteria": [
          ],
        • "status": "ACTIVE"
        }

        Modify a promotion

        Use this resource to update a promotion by its unique id.
        Updating offer bundle via this endpoint is deprecated. Please migrate to /sale/bundles/{bundleId}/discount endpoint which is dedicated for bundles.
        It supports editing bundle's discount, wholesale price lists and large order discounts. Amount of the discount in a bundle can be edited, but cannot change the offers a bundle consists of. Read more about: Bundles PL / EN, Large order discount PL / EN, Wholesale price list PL / EN.

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

        Promotion identifier.

        Request Body schema: application/vnd.allegro.public.v1+json
        required
        Array of objects (Benefit) [ items ]

        What kind of rebate will be given

        required
        Array of objects (SellerRebateOfferCriterion) [ items ]

        What offers will be included

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Bundle
        Bundle
        Large Order Discount
        Wholesale Price List
        {
        • "benefits": [
          ],
        • "offerCriteria": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Bundle
        Bundle
        Large Order Discount
        Wholesale Price List
        {
        • "status": "ACTIVE",
        • "createdAt": "2019-05-12T10:02:31.123Z",
        • "id": "72c40ffb-6127-4719-a473-867bf5775601",
        • "benefits": [
          ],
        • "offerCriteria": [
          ]
        }

        Deactivate a promotion by id

        Use this resource to deactivate the requested promotion. You need to use its unique id.
        Deleting offer bundle via this endpoint is deprecated. Please migrate to /sale/bundles/{bundleId} endpoint which is dedicated for bundles.
        Read more about: Large order discount PL / EN, Wholesale price list PL / EN, Bundles PL / EN, Multipack PL / EN.

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

        Promotion identifier.

        Responses

        Response samples

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

        Offer bundles

        Create a new offer bundle

        You can create offer bundle using this endpoint. Bundle has to contain at least two offers and at least one of them has to be set as an entry point. Bundle will be shown on offers' pages which are marked as entry points. You can also specify how many units of each offer will be in bundle using requiredQuantity property.
        Additionally, discount can be specified for each marketplace separately. If you do not want to set discount, set discounts property to null or empty array. Also, you do not have to specify discount on all marketplaces. Fill marketplaces in 'discounts' array accordingly to your needs.
        For now the only supported marketplace is allegro-pl.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        required
        Array of objects (BundledOfferDTO) [ items ]

        Offers that will make up the bundle.

        Array of objects or null (BundleDiscountDTO)

        Discounts on marketplaces. Can be null or empty if bundle shouldn't have discount on any marketplace.

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "a42d09c2-2669-4e7c-989b-7c341e84f787",
        • "offers": [
          ],
        • "publication": [
          ],
        • "discounts": [
          ],
        • "createdAt": "2023-09-21T10:22:02.999Z",
        • "createdBy": "USER"
        }

        List seller's bundles

        You can fetch page of seller's offer bundles using this endpoint.
        Paging:
        To move to next page, specify page.id parameter with value obtained in response from previous request. Number of offer bundles on single page can be specified using limit parameter.
        Filtering:
        Offer bundles can be filtered to bundles which contain offer specified in offer.id parameter.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 5000 ]
        Default: 50

        Limit of bundles per page.

        offer.id
        string
        Example: offer.id=123456789

        Filter bundles which contains offer.

        page.id
        string
        Example: page.id=MjAyNC0wOS0xMFQwNjo0OTowMi40NTBa

        ID of page which will be retrieved.

        Responses

        Response samples

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

        Get bundle by ID

        Use this resource to retrieve offer bundle by its unique identifier.

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

        Bundle ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "a42d09c2-2669-4e7c-989b-7c341e84f787",
        • "offers": [
          ],
        • "publication": [
          ],
        • "discounts": [
          ],
        • "createdAt": "2023-09-21T10:22:02.999Z",
        • "createdBy": "USER"
        }

        Delete bundle by ID

        Use this resource to delete offer bundle by its unique identifier.

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

        Bundle ID.

        Responses

        Response samples

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

        Update discount associated with bundle

        Use this resource to update discount per marketplaces associated with bundle specified by its unique identifier. This will override currently set discounts for all marketplaces, so the unchanged discounts also must be specified in request. In case discount for marketplace is not specified in request it will be deleted.

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

        Bundle ID.

        Request Body schema: application/vnd.allegro.public.v1+json
        Array of objects or null (BundleDiscountDTO)

        Discounts on marketplaces. Can be null or empty if bundle shouldn't have discount on any marketplace.

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "a42d09c2-2669-4e7c-989b-7c341e84f787",
        • "offers": [
          ],
        • "publication": [
          ],
        • "discounts": [
          ],
        • "createdAt": "2023-09-21T10:22:02.999Z",
        • "createdBy": "USER"
        }

        Badge campaigns

        Get a list of available badge campaigns

        Badge campaigns are another way to promote your offers. You can apply for a badge, which - depending on a type - will be displayed on your offer page of on the list of offers. First - use this resource to get a list of all available badge campaigns at the moment, then use POST /sale/badges to apply for badge. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)

        Responses

        Response samples

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

        Apply for badge in selected offer

        This resource allows you to apply for a badge. Most badges involve additional fee charged. Your badge application will be verified and you will be notified about the verification status via e-mail. You can use Location provided in header of the response to track your application status. Application will be removed after 30 days when status of the application was changed form PROCESSED or DECLINED. Fees will be charged in accordance with Annex No. 1 to the Daily deals zone terms and conditions.

        By using this resource you agree to the Daily deals zone terms and conditions or Commission discount terms and conditions. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        Request Body schema: application/vnd.allegro.public.v1+json
        required
        object (BadgeApplicationCampaign)
        required
        object (BadgeOffer)
        object or null (BadgeApplicationPrices)

        Required by DISCOUNT and SOURCING campaign.

        object (BadgeApplicationPurchaseConstraints)

        Constraints of purchase of this offer while it participates in the campaign. Optional for all campaigns types.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Discount
        Discount
        Standard
        Sourcing
        Discount with purchase limit
        {
        • "campaign": {
          },
        • "offer": {
          },
        • "prices": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Discount badge application
        Discount badge application
        Discount badge application with purchase limit
        {
        • "id": "01234567-89ab-0123-456789ab",
        • "createdAt": "2011-12-03T10:15:30Z",
        • "updatedAt": "2011-12-03T10:15:30Z",
        • "campaign": {
          },
        • "offer": {
          },
        • "prices": {
          },
        • "process": {
          }
        }

        Get a list of badges

        Use this resource to get a list of badges in authorized seller's offers. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        query Parameters
        offer.id
        string

        Offer ID.

        offset
        integer >= 0

        Offset.

        limit
        integer [ 1 .. 1000 ]
        Default: 50

        The maximum number of badges returned in the response.

        Responses

        Response samples

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

        Get a badge application details

        Use this resource to get a badge application details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        path Parameters
        applicationId
        required
        string

        Badge application ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Processed
        Processed
        Requested
        Declined
        {
        • "id": "81ff5e67-d00b-4141-a79a-68636755df95",
        • "createdAt": "2019-05-16T12:49:17.347Z",
        • "updatedAt": "2019-05-16T12:49:17.530Z",
        • "campaign": {
          },
        • "offer": {
          },
        • "prices": {
          },
        • "process": {
          }
        }

        Get a list of badge applications

        Use this resource to get a list of badge applications. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        query Parameters
        campaign.id
        string

        Campaign ID.

        offer.id
        string

        Offer ID.

        offset
        integer >= 0

        Offset.

        limit
        integer [ 1 .. 1000 ]
        Default: 50

        The maximum number of applications returned in the response.

        Responses

        Response samples

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

        Get badge operation details

        Use this resource to get badge operation details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        path Parameters
        operationId
        required
        string

        Badge operation ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Processed
        Processed
        Requested
        Declined
        {
        • "id": "81ff5e67-d00b-4141-a79a-68636755df95",
        • "type": "FINISH",
        • "createdAt": "2019-05-16T12:49:17.347Z",
        • "updatedAt": "2019-05-16T12:49:17.530Z",
        • "campaign": {
          },
        • "offer": {
          },
        • "process": {
          }
        }

        Update campaign badge for the given offer

        This resource allows you to update a campaign badge for the given offer. You can use Location provided in header of the response to track your update status. Update offer price in a campaign or finish marking an offer in a campaign. Read more: PL / EN.

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

        Offer ID.

        campaignId
        required
        string

        Campaign ID.

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

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Price update for the given offer in the given campaign
        Price update for the given offer in the given campaign
        Remove campaign badge from the given offer
        {
        • "prices": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "154179f0-ed4c-4b84-9260-302d2dec3801"
        }

        Allegro Prices

        Get the current consents' state for an offer

        Use this resource to get the current Allegro Prices consent value for the offer on each of the available marketplaces. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        path Parameters
        offerId
        required
        string

        The offer ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "status": "ALLOWED",
        • "additionalMarketplaces": {
          }
        }

        Update consents for an offer

        Use this resource to update the Allegro Prices consent value for the offer on chosen marketplaces. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        path Parameters
        offerId
        required
        string

        The offer ID.

        Request Body schema: application/vnd.allegro.public.v1+json
        status
        string
        Enum: "ALLOWED" "DENIED"

        Use it to update the consent on the base marketplace of the offer.

        object

        Use it to update the consent on marketplaces other than the base marketplace of the offer.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "status": "DENIED",
        • "additionalMarketplaces": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "status": "DENIED",
        • "additionalMarketplaces": {
          }
        }

        Get the current eligibility information for the account

        Use this resource to get the current Allegro Prices eligibility information for the account on each of the available marketplaces. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "consent": "ALLOWED",
        • "qualification": {
          },
        • "additionalMarketplaces": {
          }
        }

        Update consents for the account

        Use this resource to update the Allegro Prices consent value for the account on chosen marketplaces. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        Request Body schema: application/json
        status
        string
        Enum: "ALLOWED" "DENIED"
        object

        Consent statuses on marketplaces other than the base marketplace of the account.

        Responses

        Request samples

        Content type
        application/json
        {
        • "status": "ALLOWED",
        • "additionalMarketplaces": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "status": "ALLOWED",
        • "additionalMarketplaces": {
          }
        }

        AlleDiscount

        Create submit offer command

        Use this resource to create a command for submitting an offer. Offer will be submitted to the AlleDiscount campaign only if command is processed successfully. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        Request Body schema: application/vnd.allegro.public.v1+json
        commandId
        string or null

        The command UUID. If empty, system generates new one.

        object

        Command input.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
        • "input": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
        • "input": {
          },
        • "output": {
          }
        }

        Get the offer submission command status

        Use this resource to get information about the submit offer command execution status. Read more: PL / EN.

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

        Command id in UUID format, must be unique.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Submit command executed with status: SUCCESSFUL
        Submit command executed with status: SUCCESSFUL
        Submit command with status: FAILED
        {
        • "id": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
        • "input": {
          },
        • "output": {
          }
        }

        Create withdraw offer command

        Use this resource to create a command for withdrawing an offer from specific campaign. Offer will be withdrawn from the AlleDiscount campaign only if command is processed successfully. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        Request Body schema: application/vnd.allegro.public.v1+json
        commandId
        string or null

        The Command UUID. If empty, system generates new one.

        object

        Command input.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
        • "input": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
        • "input": {
          },
        • "output": {
          }
        }

        Get the offer withdrawal command status

        Use this resource to get information about the withdrawal command execution status. Read more: PL / EN.

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

        Command id in UUID format, must be unique.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Withdraw command with status: SUCCESSFUL
        Withdraw command with status: SUCCESSFUL
        Withdraw command with status: FAILED
        {
        • "id": "c1b3f63d-d293-4333-911d-a0c1053e2c81",
        • "input": {
          },
        • "output": {
          }
        }

        List eligible offers

        Endpoint returning info about offers that can be submitted to a given AlleDiscount campaign. Only offer linked to the product in published list of goods (products) can be submitted to a given AlleDiscount campaign. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        path Parameters
        campaignId
        required
        string

        Campaign id to list offers from.

        query Parameters
        limit
        integer

        Maximum number of offers returned in the eligibleOffers list; max value is 200.

        offset
        integer

        The number of offers to skip while listing the results.

        meetsConditions
        boolean

        If true, filters offers that only meet conditions of the campaign.

        offerId
        string

        ID of an offer; if the offer with the given ID exists, returns at most one element in the eligibleOffers list.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Offers that meet conditions.
        Offers that meet conditions.
        Offers that don't meet conditions.
        Offers for which we are still gathering price info.
        {
        • "eligibleOffers": [
          ],
        • "count": 1,
        • "totalCount": 1
        }

        List offer participations

        Endpoint returning info about offer participations for a given AlleDiscount campaign. With this endpoint you are able to validate if the offer participates in AlleDiscount and if it has lowered price on the platform. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        path Parameters
        campaignId
        required
        string

        Campaign id to list offers from.

        query Parameters
        limit
        integer

        Maximum number of offers returned in the eligibleOffers list; max value is 200.

        offset
        integer

        The number of offers to skip while listing the results.

        offerId
        string

        ID of an offer; if the offer with the given ID exists, returns at most one element in the submittedOffers list.

        participationId
        string

        Id of the participation, returns at most one element in the submittedOffers list.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        Offer participation with status "ACCEPTED".
        Offer participation with status "ACCEPTED".
        Offer participation with status "DECLINED".
        {
        • "submittedOffers": [
          ],
        • "count": 1,
        • "totalCount": 1
        }

        List AlleDiscount campaigns

        List current AlleDiscount campaigns. Each campaign has its own list of goods (products) that indicate which offers can be submitted to it. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:campaigns)
        query Parameters
        campaignId
        string

        Id of the searched campaign. If present, returns at most one entry.

        Responses

        Response samples

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

        Offer rating

        Get offer rating

        Use this resource to get offer rating. 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
        {
        • "averageScore": "4.0",
        • "scoreDistribution": [
          ],
        • "totalResponses": 5,
        • "sizeFeedback": [
          ]
        }

        Classifieds

        Get the seller's advertisements daily statistics

        This endpoint returns daily statistics collected for a list of advertisements in a given date range for logged user. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        date.gte
        string <date-time>
        Example: date.gte=2020-11-13T12:45:20.818Z

        The maximum date and time from which the events will be fetched in ISO 8601 format. The value should be less than the current date time. The difference between date.gte and date.lte should be less than 3 months.

        date.lte
        string <date-time>
        Example: date.lte=2020-11-13T12:45:20.818Z

        The minimum date and time from which the events will be fetched in ISO 8601 format. The value should be less than the current date time and greater than date.lte. The difference between date.gte and date.lte should be less than 3 months.

        Responses

        Response samples

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

        Get the advertisements daily statistics

        This endpoint returns daily statistics collected for a list of advertisements in a given date range. Read more: PL / EN.

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

        List of offer Ids, maximum 50 values.

        date.gte
        string <date-time>
        Example: date.gte=2020-11-13T12:45:20.818Z

        The maximum date and time from which the events will be fetched in ISO 8601 format. The value should be less than the current date time. The difference between date.gte and date.lte should be less than 3 months.

        date.lte
        string <date-time>
        Example: date.lte=2020-11-13T12:45:20.818Z

        The minimum date and time from which the events will be fetched in ISO 8601 format. The value should be less than the current date time and greater than date.lte. The difference between date.gte and date.lte should be less than 3 months.

        Responses

        Response samples

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

        Get classified packages assigned to an offer

        Use this resource to retrieve classified packages currently assigned to an offer. Read more: PL / EN.

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

        Offer ID.

        Responses

        Response samples

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

        Assign packages to a classified

        Use this resource to assign classified packages to an offer. Read more: PL / EN.

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

        The offer ID.

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

        Packages that should be assigned to the classified.

        required
        object (ClassifiedPackage)
        Array of objects (ClassifiedPackage) [ items ]

        Responses

        Request samples

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

        Response samples

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

        Get configurations of packages

        Use this resource to retrieve configurations of classifieds packages for a category. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        query Parameters
        category.id
        required
        string

        The category ID.

        Responses

        Response samples

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

        Get the configuration of a package

        Use this resource to retrieve the configuration of a classifieds package. Read more: PL / EN.

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

        The classifieds package ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "extensions": [
          ],
        • "id": "6174be19-56f9-484b-b72c-43b0b00785e8",
        • "name": "Power",
        • "promotions": [
          ],
        • "publication": {
          },
        • "type": "BASE"
        }

        Pricing

        Calculate fee and commission for an offer

        Provides information about fee and commission for an offer. This resource is limited to 25 requests per second for a single user. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:offers:read)
        Request Body schema: application/vnd.allegro.public.v1+json
        object (PricingOffer)

        Single offer data.

        object (ClassifiedsPackages)
        marketplaceId
        string or null

        The marketplace on which the offer should be previewed. If omitted, it will default to the base marketplace.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "offer": {
          },
        • "classifiedsPackages": {
          },
        • "marketplaceId": "allegro-pl"
        }

        Response samples

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

        Get the user's current offer quotes

        This endpoint returns current offer quotes (listing and promo fees) cycles for authenticated user and list of offers. Read more: PL / EN.

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

        List of offer Ids, maximum 20 values.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "count": 0,
        • "quotes": [
          ]
        }

        Order management

        Get order events

        Use this resource to return events that allow you to monitor actions which clients perform, i.e. making a purchase, filling in the checkout form (FOD), finishing payment process, making a surcharge. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        query Parameters
        from
        string

        You can use the event ID to retrieve subsequent chunks of events.

        type
        Array of strings

        Specify array of event types for filtering. Allowed values are:

        • BOUGHT: purchase without checkout form filled in
        • FILLED_IN: checkout form filled in but payment is not completed yet so data could still change
        • READY_FOR_PROCESSING: payment completed. Purchase is ready for processing
        • BUYER_CANCELLED: purchase was cancelled by buyer
        • FULFILLMENT_STATUS_CHANGED: fulfillment status changed
        • AUTO_CANCELLED: purchase was cancelled automatically by Allegro.
        limit
        integer <int32> [ 1 .. 1000 ]
        Default: 100

        The maximum number of events returned in the response.

        Responses

        Response samples

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

        Get order events statistics

        Use this resource to returns object that contains event id and occurrence date of the latest event. It gives you current starting point for reading events. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)

        Responses

        Response samples

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

        Get the user's orders

        Use this resource to get an order list. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        query Parameters
        offset
        integer >= 0
        Default: 0

        Index of first returned checkout-form from all search results.

        limit
        integer [ 1 .. 100 ]
        Default: 100

        Maximum number of checkout-forms in response.

        status
        string

        Specify status value that checkout-forms must have to be included in the output. Allowed values are:

        • BOUGHT: purchase without checkout form filled in.
        • FILLED_IN: checkout form filled in but payment is not completed yet so data could still change.
        • READY_FOR_PROCESSING: payment completed. Purchase is ready for processing.
        • CANCELLED: purchase cancelled by buyer.
        fulfillment.status
        string

        Specify seller status value that checkout-forms must have to be included in the output. Allowed values are:

        • NEW
        • PROCESSING
        • READY_FOR_SHIPMENT
        • READY_FOR_PICKUP
        • SENT
        • PICKED_UP
        • CANCELLED
        • SUSPENDED.
        fulfillment.shipmentSummary.lineItemsSent
        string

        Specify filter for line items sending status. Allowed values are:

        • NONE: none of line items have tracking number specified
        • SOME: some of line items have tracking number specified
        • ALL: all of line items have tracking number specified.
        lineItems.boughtAt.lte
        string <date-time>

        Latest line item bought date. The upper bound of date time range from which checkout forms will be taken.

        lineItems.boughtAt.gte
        string <date-time>

        Latest line item bought date. The lower bound of date time range from which checkout forms will be taken.

        payment.id
        string

        Find checkout-forms having specified payment id.

        surcharges.id
        string

        Find checkout-forms having specified surcharge id.

        delivery.method.id
        string

        Find checkout-forms having specified delivery method id.

        buyer.login
        string

        Find checkout-forms having specified buyer login.

        marketplace.id
        string

        Find checkout-forms of orders purchased on specified marketplace.

        updatedAt.lte
        string <date-time>

        Checkout form last modification date. The upper bound of date time range from which checkout forms will be taken.

        updatedAt.gte
        string <date-time>

        Checkout form last modification date. The lower bound of date time range from which checkout forms will be taken.

        sort
        string
        Enum: "lineItems.boughtAt" "-lineItems.boughtAt" "updatedAt" "-updatedAt"

        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 line item boughtAt date, descending.

        Responses

        Response samples

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

        Get an order's details

        Use this resource to get an order details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        path Parameters
        id
        required
        string <uuid>
        Example: 29738e61-7f6a-11e8-ac45-09db60ede9d6

        Checkout form identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "29738e61-7f6a-11e8-ac45-09db60ede9d6",
        • "messageToSeller": "Please send me an item in red color",
        • "buyer": {
          },
        • "payment": {
          },
        • "status": "READY_FOR_PROCESSING",
        • "fulfillment": {
          },
        • "delivery": {
          },
        • "invoice": {
          },
        • "lineItems": [
          ],
        • "surcharges": [
          ],
        • "discounts": [
          ],
        • "note": {
          },
        • "marketplace": {
          },
        • "summary": {
          },
        • "updatedAt": "2011-12-03T10:15:30.133Z",
        • "revision": "819b5836"
        }

        Get a list of available shipping carriers

        Shipping carriers are essential to provide accurate tracking experience for customers. Use this resource to get a list of all available shipping carriers.

        The response of this resource can be stored in accordance with returned caching headers. Read more: PL / EN.

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

        Responses

        Response samples

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

        Get a list of parcel tracking numbers

        Get a list of parcel tracking numbers currently assigned to the order. Orders can be retrieved using REST API resource GET /order/checkout-forms. Please note that the shipment list may contain parcel tracking numbers added through other channels such as Moje Allegro or by the carrier that delivers the parcel. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        path Parameters
        id
        required
        string

        Order identifier.

        Responses

        Response samples

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

        Add a parcel tracking number

        Add a parcel tracking number (shipment) to given order line items. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:write)
        path Parameters
        id
        required
        string

        Order identifier.

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

        request

        carrierId
        required
        string

        Supported carriers are available via shipping carriers resource.

        waybill
        required
        string <= 64 characters

        Waybill number (parcel tracking number). Cannot be empty and must be no longer than 64 characters.

        carrierName
        string <= 30 characters

        Carrier name to be provided only if carrierId is OTHER, otherwise it’s ignored. Must be no longer than 30 characters.

        Array of objects[ items ]

        List of order line items. They must be from the order specified in the path parameter. When list is not provided or it is empty it means that every item from an order is included in shipment.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "carrierId": "string",
        • "waybill": "string",
        • "carrierName": "string",
        • "lineItems": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "waybill": "string",
        • "carrierId": "string",
        • "carrierName": "string",
        • "lineItems": [
          ],
        • "createdAt": "string"
        }

        Set seller order status

        Use to set seller order status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:write)
        path Parameters
        id
        required
        string

        Order identifier.

        query Parameters
        checkoutForm.revision
        string
        Example: checkoutForm.revision=819b5836

        Checkout form revision.

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

        request

        status
        any (CheckoutFormFulfillmentStatus)
        Enum: "NEW" "PROCESSING" "READY_FOR_SHIPMENT" "READY_FOR_PICKUP" "SENT" "PICKED_UP" "CANCELLED" "SUSPENDED"

        Order seller status.

        object (CheckoutFormFulfillmentShipmentSummary)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "status": "SENT",
        • "shipmentSummary": {
          }
        }

        Response samples

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

        Get order invoices details

        Use to get invoices details including antivirus scan results and EPT invoice verification status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        path Parameters
        id
        required
        string

        Order identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "invoices": [
          ],
        • "hasExternalInvoices": true
        }

        Post new invoice

        Use to add new invoice metadata. Before you send an invoice file, you need to initialize the invoice instance with the required parameters. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        path Parameters
        id
        required
        string

        Order identifier.

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

        request

        required
        object (CheckFormsNewOrderInvoiceFile)
        invoiceNumber
        string

        Responses

        Request samples

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

        Response samples

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

        Upload invoice file

        Use to upload invoice file to match created invoice metadata. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        path Parameters
        id
        required
        string

        Order identifier.

        invoiceId
        required
        string

        Invoice identifier.

        Request Body schema: application/pdf
        string <binary>

        File in a binary format

        Responses

        Response samples

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

        Get Allegro pickup drop off points

        Get a list of Allegro pickup drop off points. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        query Parameters
        carriers
        Array of strings (AllegroCarrier)
        Items Enum: "UPS" "ALLEGRO_ONE_KURIER" "DPD"

        List of carrier ids to filter the drop off/pick up points to only the ones where any of the listed carriers operate. In case of an empty list, all points are returned.

        header Parameters
        If-Modified-Since
        string <<day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT>
        Example: Sat, 01 Dec 2018 10:00:00 GMT

        Date of last data modification. If data has been modified after specified date, full set of data is returned. If header is not specified, full set of data is returned. Date has to be provided in HTTP-date format. Information about date (the same HTTP-date format) of last modified data is available in response - Last-Modified.

        Responses

        Response samples

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

        Get carrier parcel tracking history

        Get tracking history for parcels. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        path Parameters
        carrierId
        required
        string

        Carrier identifier.

        query Parameters
        waybill
        required
        Array of strings <= 20 items

        Waybill number (parcel tracking number). Example: waybill=AAA0000E5D201&waybill=BBB00000E5D202 - returns parcel tracking history for AAA0000E5D201 as well as for BBB00000E5D202.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "carrierId": "string",
        • "waybills": [
          ]
        }

        Payments

        Payment operations history

        Use this endpoint to get the list of the seller payment operations. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:payments:read)
        query Parameters
        wallet.type
        string
        Default: "AVAILABLE"
        Enum: "AVAILABLE" "WAITING"

        Type of the wallet: * AVAILABLE - operations available for payout. * WAITING - operations temporarily suspended for payout.

        wallet.paymentOperator
        string
        Enum: "PAYU" "P24" "AF"

        Payment operator: * PAYU - operations processed by PAYU operator. * P24 - operations processed by PRZELEWY24 operator. * AF - operations processed by Allegro Finance operator.

        payment.id
        string <uuid>

        The payment ID.

        participant.login
        string

        Login of the participant. In case of REFUND_INCREASE operation this is the login of the seller, in other cases, of the buyer.

        occurredAt.gte
        string <date-time>
        Example: occurredAt.gte=2019-05-08T09:45:20.818Z

        The minimum date and time of operation occurrence in ISO 8601 format.

        occurredAt.lte
        string <date-time>
        Example: occurredAt.lte=2019-05-08T09:45:20.818Z

        The maximum date and time of operation occurrence in ISO 8601 format.

        group
        Array of strings
        Items Enum: "INCOME" "OUTCOME" "REFUND" "BLOCKADES"

        Group of operation types: * INCOME - CONTRIBUTION, SURCHARGE, CORRECTION, DEDUCTION_INCREASE, COMPENSATION. * OUTCOME - PAYOUT, PAYOUT_CANCEL, DEDUCTION_CHARGE. * REFUND - REFUND_CHARGE, REFUND_CANCEL, REFUND_INCREASE, CORRECTION. * BLOCKADES - BLOCKADE, BLOCKADE_RELEASE.

        marketplaceId
        string
        Enum: "allegro-pl" "allegro-cz"
        Example: marketplaceId=allegro-pl

        The marketplace ID where operation was made. When the parameter is omitted, searches for operations with all marketplaces. Note, that there are operations not assigned to any marketplace.

        currency
        string
        Example: currency=PLN

        Currency of the operations.

        limit
        integer <int32> [ 1 .. 50 ]
        Default: 50

        Number of returned operations.

        offset
        integer <int32> [ 0 .. 10000 ]
        Default: 0

        Index of the first returned payment operation from all search results.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "paymentOperations": [
          ],
        • "count": 50,
        • "totalCount": 123
        }

        Initiate a refund of a payment

        Use this endpoint to initiate a refund of a payment. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:payments:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        required
        object (RefundPayment)

        Payment affected by refund operation.

        reason
        required
        string
        Enum: "REFUND" "COMPLAINT" "PRODUCT_NOT_AVAILABLE" "PAID_VALUE_TOO_LOW" "OVERPAID" "CANCELLED_BY_BUYER" "NOT_COLLECTED"

        Reason for a payment refund.

        Array of objects (RefundLineItem) [ items ]

        List of order's line items which can be refunded.

        object

        Payment refund for delivery.

        object

        Payment refund for overpaid.

        Array of objects (PaymentsSurcharge) [ items ]

        List of surcharges for payment which can be refunded.

        object

        Payment refund for additional services.

        sellerComment
        string <= 250 characters

        Sellers optional justification for refund.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "payment": {
          },
        • "reason": "REFUND",
        • "lineItems": [
          ],
        • "delivery": {
          },
        • "overpaid": {
          },
        • "surcharges": [
          ],
        • "additionalServices": {
          },
        • "sellerComment": "Example seller comment."
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "payment": {
          },
        • "reason": "REFUND",
        • "status": "SUCCESS",
        • "createdAt": "2017-05-17T08:36:57.292+02:00",
        • "totalValue": {
          },
        • "lineItems": [
          ],
        • "delivery": {
          },
        • "overpaid": {
          },
        • "surcharges": [
          ],
        • "additionalServices": {
          },
        • "sellerComment": "Example seller comment."
        }

        Get a list of refunded payments

        Get a list of refunded payments. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:payments:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 100 ]
        Default: 50

        Number of returned operations.

        offset
        integer <int32> >= 0
        Default: 0

        Index of the first returned payment operation from all search results.

        id
        string <uuid>

        ID of the refund.

        payment.id
        string <uuid>

        ID of the payment.

        occurredAt.gte
        string <date-time>
        Example: occurredAt.gte=2019-05-08T09:45:43.818Z

        Minimum date and time when the refund occurred provided in ISO 8601 format.

        occurredAt.lte
        string <date-time>
        Example: occurredAt.lte=2019-05-08T09:45:32.818Z

        Maximum date and time when the refund occurred provided in ISO 8601 format.

        status
        Array of strings
        Items Enum: "WAITING" "IN_PROGRESS" "SUCCESS" "CANCELED" "PARTIAL"

        Current status of payment refund.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "refunds": [
          ],
        • "count": 50,
        • "totalCount": 123
        }

        Disputes

        Get the user's disputes

        Use this resource to get the list of your disputes ordered by descending opened date. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:disputes)
        query Parameters
        checkoutForm.id
        string <uuid>
        Example: checkoutForm.id=29738e61-7f6a-11e8-ac45-09db60ede9d6

        Checkout form identifier.

        limit
        integer <int32> [ 1 .. 100 ]
        Default: 10

        The maximum number of disputes in a response.

        offset
        integer <int32> >= 0
        Default: 0

        Index of first returned dispute.

        status
        Array of strings
        Items Enum: "CLOSED" "ONGOING" "UNRESOLVED"

        Filter disputes with given set of statuses.

        Responses

        Response samples

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

        Get a single dispute

        Use this resource to get a single dispute. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:disputes)
        path Parameters
        disputeId
        required
        string <uuid>

        Dispute identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "subject": {
          },
        • "status": "CLOSED",
        • "messagesStatus": "NEW",
        • "buyer": {
          },
        • "checkoutForm": {
          },
        • "message": {},
        • "messagesCount": 0,
        • "openedDate": "2018-02-10T12:12:12.000Z",
        • "lastMessageCreationDate": "2018-02-10T12:12:12.000Z",
        • "claim": {
          }
        }

        Get the messages within a dispute

        Use this resource to get the list of messages within dispute. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:disputes)
        path Parameters
        disputeId
        required
        string <uuid>

        Dispute identifier.

        query Parameters
        limit
        integer <int32> [ 1 .. 100 ]
        Default: 10

        The maximum number of messages within dispute returned in a response.

        offset
        integer <int32> >= 0
        Default: 0

        Index of first returned message within dispute.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {}

        Add a message to a dispute

        Use this resource to post a message in certain dispute. At least one of fields: 'text', 'attachment' has to be present. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:disputes)
        path Parameters
        disputeId
        required
        string <uuid>

        Dispute identifier.

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

        Message request

        text
        required
        string <= 20000 characters
        required
        object (DisputeAttachmentId)
        type
        required
        string
        Enum: "REGULAR" "END_REQUEST"

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "text": "string",
        • "attachment": {
          },
        • "type": "REGULAR"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {}

        Create an attachment declaration

        Use this resource to post an attachment declaration. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:disputes)
        Request Body schema: application/vnd.allegro.public.v1+json

        A detailed declaration of a file to be uploaded

        fileName
        required
        string
        size
        required
        integer >= 1

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "fileName": "string",
        • "size": 128
        }

        Response samples

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

        Upload a dispute message attachment

        Upload a dispute message attachment. This operation should be used after creating an attachment declaration with POST /sale/dispute-attachments Important! You can find the URL address to upload the file to our server in the Location response header of POST /sale/dispute-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:disputes)
        path Parameters
        attachmentId
        required
        string <uuid>

        Attachment identifier.

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

        File in a binary format

        Responses

        Get an attachment

        Use this resource to get an attachment. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:disputes)
        path Parameters
        attachmentId
        required
        string <uuid>

        Attachment identifier.

        Responses

        Parcel management

        Get available delivery services Deprecated

        Use this resource to get delivery services available for user. It returns services provided by Allegro and contracts with carriers owned by user and configured by GUI. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:readallegro:api:shipments:read)

        Responses

        Response samples

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

        Create a new parcel Deprecated

        Use this resource to create parcel for delivery. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:writeallegro:api:shipments:write)
        path Parameters
        commandId
        required
        string

        Command UUID.

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

        Delivery service id.

        required
        object (Receiver)

        Parcel's receiver data.

        required
        object (Pickup)

        Parcel's pickup data.

        required
        Array of objects (ParcelItemDetails) [ items ]

        Parcel items details.

        type
        string
        Enum: "PACKAGE" "DOX" "PALLET"

        Value will be applied to type for all items. If item will have type value assigned - validation will check if all types have the same value.

        object
        object (ParcelAdditionalServices)

        Additional services.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "serviceId": "6179d6a9-c007-4122-aed9-9b32993b1b05#937160ed-7c44-4ea6-af78-1e233779e681",
        • "receiver": {
          },
        • "pickup": {
          },
        • "items": [
          ],
        • "type": "PACKAGE",
        • "label": {
          },
        • "additionalServices": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
        • "input": {
          }
        }

        Get parcel creation status Deprecated

        Use this resource to get parcel creation status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:writeallegro:api:shipments:write)
        path Parameters
        commandId
        required
        string

        Command UUID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
        • "parcelId": "259b5c7a-9056-4c74-80ec-9bb2978cf293",
        • "status": "ERROR",
        • "errors": [
          ]
        }

        Get parcel details Deprecated

        Use this resource to get parcel details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:readallegro:api:shipments:read)
        path Parameters
        parcelId
        required
        string

        Id of parcel.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "parcelId": "66032969-eb5b-47a2-b7e8-72e5a09f9a73",
        • "serviceId": "045cda68-a744-4d1f-a9c5-eb3a64d080f3#634c72a0-95f0-4480-b0fa-93b77e4cffb4",
        • "receiver": {
          },
        • "pickup": {
          },
        • "items": [
          ],
        • "type": "PACKAGE",
        • "label": {
          },
        • "additionalServices": {
          },
        • "state": "DRAFT"
        }

        Get parcels pickup date proposals Deprecated

        Use this resource to get parcels pickup date proposals. Pickup takes place, when courier arrives to take parcels for shipment. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:readallegro:api:shipments:read)
        query Parameters
        parcelId
        required
        Array of strings <= 100 items [ items <= 100 characters ]

        Ids of parcels. Passing more than one value will search pickup dates for all of them separately. Example: parcelId=adc05c84-a9eb-4981-bbc0-773d8c0017e7&parcelId=adc05c84-a9eb-4981-bbc0-773d8c0017e8 - will return pickup date proposals for parcels with ID adc05c84-a9eb-4981-bbc0-773d8c0017e7 and adc05c84-a9eb-4981-bbc0-773d8c0017e8.

        readyDate
        string <date>
        Example: readyDate=2020-01-01

        Date when parcels will be ready.

        Responses

        Response samples

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

        Request parcel pickup Deprecated

        Use this resource to request pickup for parcels. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:writeallegro:api:shipments:write)
        path Parameters
        commandId
        required
        string

        Command UUID.

        Request Body schema: application/vnd.allegro.public.v1+json
        parcelIds
        Array of strings

        Ids of parcels.

        object (PickupDateProposal)

        Parcel pickup date. In pickup request you have to use exactly the same values as you get from /parcel-management/pickup-date-proposals.

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
        • "input": {
          }
        }

        Get parcel pickup status Deprecated

        Use this resource to get parcel pickup status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:writeallegro:api:shipments:write)
        path Parameters
        commandId
        required
        string

        Command UUID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
        • "status": "ERROR",
        • "errors": [
          ]
        }

        Get parcel label Deprecated

        Use this resource to get label for created parcel.
        Returned content type depends on created parcel. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:readallegro:api:shipments:read)
        query Parameters
        parcelId
        required
        string

        Id of parcel.

        pageFormat
        string
        Enum: "A4" "A6"

        Label page format. Only for PDF file.

        Responses

        Response samples

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

        Get parcels protocol Deprecated

        Use this resource to get parcels protocol. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:readallegro:api:shipments:read)
        query Parameters
        parcelId
        required
        Array of strings <= 100 items [ items <= 100 characters ]

        Ids of parcels. Passing more than one value will generate protocol for all of them. Example: parcelId=2c6d5ca1-e892-455f-ae24-89ba7c12abcd&parcelId=2c6d5ca1-e892-455f-ae24-89ba7c12abc1 - returns protocol for parcels with ID 2c6d5ca1-e892-455f-ae24-89ba7c12abcd and 2c6d5ca1-e892-455f-ae24-89ba7c12abc1.

        Responses

        Response samples

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

        Cancel parcel Deprecated

        Use this resource to cancel parcel. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:writeallegro:api:shipments:write)
        path Parameters
        commandId
        required
        string

        Command UUID.

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

        Id of parcel.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "parcelId": "ff5bdf59-8c89-4dd5-bf6a-a54805be85ad"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
        • "input": {
          }
        }

        Get parcel cancellation status Deprecated

        Use this resource to get parcel cancellation status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:writeallegro:api:shipments:write)
        path Parameters
        commandId
        required
        string

        Command UUID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "b572cdd0-7f2c-4800-9165-15795bd95f3c",
        • "status": "ERROR",
        • "errors": [
          ]
        }

        Shipment management

        Get available delivery services

        Use this resource to get delivery services available for user. It returns services provided by Allegro and contracts with carriers owned by user and configured by GUI. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)

        Responses

        Response samples

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

        Create new shipment

        Use this resource to create shipment for delivery. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        commandId
        string

        Command UUID. If empty, then system generate new one.

        required
        object (ShipmentCreateRequestDto)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "input": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "input": {
          }
        }

        Get shipment creation command status

        Use this resource to get shipment creation status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        path Parameters
        commandId
        required
        string
        Example: 14e142cf-e8e0-48cc-bcf6-399b5fd90b32

        Command UUID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "status": "IN_PROGRESS",
        • "errors": [
          ],
        • "shipmentId": "ba88f0fb-acf3-438a-877e-580da50c0874"
        }

        Cancel shipment

        Use this resource to cancel parcel. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        commandId
        string

        Command UUID. If empty, then system generate new one.

        required
        object (ShipmentCancelRequestDto)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "input": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "input": {
          }
        }

        Get shipment cancellation status

        Use this resource to get parcel cancellation status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        path Parameters
        commandId
        required
        string
        Example: 14e142cf-e8e0-48cc-bcf6-399b5fd90b32

        Command UUID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "status": "IN_PROGRESS",
        • "errors": [
          ],
        • "shipmentId": "ba88f0fb-acf3-438a-877e-580da50c0874"
        }

        Get shipment details

        Use this resource to get parcel details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:read)
        path Parameters
        shipmentId
        required
        string

        Shipment id.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "ba88f0fb-acf3-438a-877e-580da50c0874",
        • "deliveryMethodId": "c3066682-97a3-42fe-9eb5-3beeccab840c",
        • "credentialsId": "c9e6f40a-3d25-48fc-838c-055ceb1c5bc0",
        • "sender": {
          },
        • "receiver": {
          },
        • "pickup": {
          },
        • "referenceNumber": "abcd1234",
        • "description": "Car wheels",
        • "packages": [
          ],
        • "insurance": {
          },
        • "cashOnDelivery": {
          },
        • "createdDate": "string",
        • "canceledDate": "string",
        • "carrier": "string",
        • "labelFormat": "PDF",
        • "additionalServices": [
          ],
        • "additionalProperties": {
          }
        }

        Get shipments labels

        Use this resource to get label for created shipment.
        Returned content type depends on created shipment. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:read)
        Request Body schema: application/vnd.allegro.public.v1+json
        shipmentIds
        required
        Array of strings [ 1 .. 2147483647 ] items
        pageSize
        string
        Enum: "A4" "A6"

        Label page format. Only for PDF file.

        cutLine
        boolean

        Put additional cut lines. Only for PDF file with A4 size.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "shipmentIds": [
          ],
        • "pageSize": "A4",
        • "cutLine": true
        }

        Response samples

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

        Get shipments protocol

        Protocol availability depends on Carrier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:read)
        Request Body schema: application/vnd.allegro.public.v1+json
        shipmentIds
        required
        Array of strings [ 1 .. 2147483647 ] items

        Responses

        Request samples

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

        Response samples

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

        Get shipments pickup proposals

        Use this resource to get parcels pickup date proposals. Pickup takes place, when courier arrives to take parcels for shipment. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        shipmentIds
        required
        Array of strings [ 1 .. 2147483647 ] items
        readyDate
        string

        Date when shipments will be ready.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "shipmentIds": [
          ],
        • "readyDate": "2020-01-01"
        }

        Response samples

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

        Request shipments pickup

        Use this resource to request a pickup of shipments. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        commandId
        string

        Command UUID. If empty, then system generate new one.

        required
        object (PickupCreateRequestDto)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "input": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "input": {
          }
        }

        Create pickup command status

        Use this resource to get pickup request status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:shipments:write)
        path Parameters
        commandId
        required
        string
        Example: 14e142cf-e8e0-48cc-bcf6-399b5fd90b32

        Command UUID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "commandId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "status": "IN_PROGRESS",
        • "errors": [
          ],
        • "pickupId": "14e142cf-e8e0-48cc-bcf6-399b5fd90b32",
        • "carrierPickupId": "A10234234523"
        }

        Customer returns

        [BETA] Get customer returns by provided query parameters

        Use this resource to get all customer returns filtered by query parameters. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        query Parameters
        customerReturnId
        string

        One or more customer return id's.

        orderId
        string

        One or more order id's.

        buyer.email
        string

        One or more buyer emails.

        buyer.login
        string

        One or more buyer logins.

        items.offerId
        string

        One or more returned item offer id's.

        items.name
        string

        One or more item names.

        parcels.waybill
        string

        One or more waybill id's.

        parcels.carrierId
        string

        One or more carrier id's.

        parcels.sender.phoneNumber
        string

        One or more phone numbers.

        referenceNumber
        string

        One or more reference numbers.

        from
        string

        The ID of the last seen customer return. Customer returns created after the given customer return will be returned.

        createdAt.gte
        string

        Date of the return in ISO 8601 format to search by greater or equal.

        createdAt.lte
        string

        Date of the return in ISO 8601 format to search by lower or equal.

        marketplaceId
        string

        The marketplace ID where operation was made. When the parameter is omitted, searches for operations with all marketplaces.

        status
        string

        Current return timeline statuses. The allowed values are:

        • CREATED
        • DISPATCHED
        • IN_TRANSIT
        • DELIVERED
        • FINISHED
        • REJECTED
        • COMMISSION_REFUND_CLAIMED
        • COMMISSION_REFUNDED
        • WAREHOUSE_DELIVERED
        • WAREHOUSE_VERIFICATION.
        limit
        integer <int32> [ 1 .. 1000 ]
        Default: 100

        Limit of customer returns per page.

        offset
        integer <int32> >= 0
        Default: 0

        The offset of elements in the response.

        Responses

        Response samples

        Content type
        application/vnd.allegro.beta.v1+json
        {
        • "count": 1,
        • "customerReturns": [
          ]
        }

        [BETA] Get customer return by id

        Use this resource to get customer returns by its identifier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        path Parameters
        customerReturnId
        required
        string

        Id of the customer return.

        Responses

        Response samples

        Content type
        application/vnd.allegro.beta.v1+json
        {
        • "id": "a3405c27-b01c-4357-9bea-e13925708b46",
        • "createdAt": "2020-01-11T09:36:57.00Z",
        • "referenceNumber": "1234/Z04A",
        • "orderId": "a3405c27-b01c-4357-9bea-e13925708b46",
        • "buyer": {
          },
        • "items": [
          ],
        • "refund": {
          },
        • "parcels": [
          ],
        • "rejection": {
          },
        • "marketplaceId": "allegro-pl",
        • "status": "DELIVERED"
        }

        [BETA] Reject customer return refund

        Use this resource to reject customer return refund with provided reason. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:write)
        path Parameters
        customerReturnId
        required
        string

        Id of the customer return.

        Request Body schema: application/vnd.allegro.beta.v1+json
        required
        object

        Refund rejection

        Responses

        Request samples

        Content type
        application/vnd.allegro.beta.v1+json
        {
        • "rejection": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.beta.v1+json
        {
        • "id": "a3405c27-b01c-4357-9bea-e13925708b46",
        • "createdAt": "2020-01-11T09:36:57.00Z",
        • "referenceNumber": "1234/Z04A",
        • "orderId": "a3405c27-b01c-4357-9bea-e13925708b46",
        • "buyer": {
          },
        • "items": [
          ],
        • "refund": {
          },
        • "parcels": [
          ],
        • "rejection": {
          },
        • "marketplaceId": "allegro-pl",
        • "status": "DELIVERED"
        }

        Commission refunds

        Get a refund application details

        Use this resource to get refund application details. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        path Parameters
        claimId
        required
        string

        Refund application ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "status": "IN_PROGRESS",
        • "quantity": 1,
        • "commission": {
          },
        • "buyer": {
          },
        • "createdAt": "2019-08-24T14:15:22Z",
        • "lineItem": {
          },
        • "type": "MANUAL"
        }

        Cancel a refund application

        Use this resource to cancel a refund application. This cannot be undone. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:write)
        path Parameters
        claimId
        required
        string

        Refund application ID.

        Responses

        Get a list of refund applications

        Use this resource to get a list of refund applications based on the provided query parameters. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:read)
        query Parameters
        lineItem.offer.id
        string

        ID of the offer associated with the refund application.

        buyer.login
        string

        Login of the buyer that made the purchase associated with the refund application.

        status
        string
        Enum: "IN_PROGRESS" "WAITING_FOR_PAYMENT_REFUND" "GRANTED" "REJECTED" "REJECTED_AFTER_APPEAL" "CANCELLED" "APPEALED"

        Status of the refund application.

        limit
        integer <int32> [ 1 .. 100 ]
        Default: 25

        Maximum number of returned refund applications in response.

        offset
        integer <int32> >= 0
        Default: 0

        Index of the first returned refund application from all search results.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "refundClaims": [
          ],
        • "count": 0
        }

        Create a refund application

        Use this resource to create a refund application. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:orders:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        object

        Purchase for which a refund application will be created.

        quantity
        integer <int32> >= 1

        Quantity of product for which the refund application will be created. Must be greater than zero.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "lineItem": {
          },
        • "quantity": 1
        }

        Response samples

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

        After sale services

        Get the user's return policies

        Use this resource to get seller return policies listing. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 60 ]
        Default: 60

        The limit of elements in the response.

        offset
        integer <int32> [ 0 .. 59 ]
        Default: 0

        The offset of elements in the response.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "count": 0,
        • "returnPolicies": [
          ]
        }

        Create new user's return policy

        Use this resource to create a return policy definition. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Return Policy

        name
        required
        string <= 200 characters

        Return policy name.

        required
        object (ReturnPolicyAvailability)
        withdrawalPeriod
        string

        Period in ISO 8601 format. Only periods in full days are accepted.

        required
        object (ReturnPolicyReturnCost)
        required
        object (ReturnPolicyAddress)
        object (ReturnPolicyContact)
        required
        object (ReturnPolicyOptions)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "availability": {
          },
        • "withdrawalPeriod": "P14D",
        • "returnCost": {
          },
        • "address": {
          },
        • "contact": {
          },
        • "options": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "availability": {
          },
        • "withdrawalPeriod": "P14D",
        • "returnCost": {
          },
        • "address": {
          },
        • "description": "string",
        • "contact": {
          },
        • "options": {
          }
        }

        Get the user's return policy

        Use this resource to get a return policy details. Read more: PL / EN.

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

        The ID of the return policy.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "availability": {
          },
        • "withdrawalPeriod": "P14D",
        • "returnCost": {
          },
        • "address": {
          },
        • "description": "string",
        • "contact": {
          },
        • "options": {
          }
        }

        Change the user's return policy

        Use this resource to modify the return policy details. Read more: PL / EN.

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

        The ID of the return policy.

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

        Return Policy

        name
        required
        string <= 200 characters

        Return policy name.

        required
        object (ReturnPolicyAvailability)
        withdrawalPeriod
        string

        Period in ISO 8601 format. Only periods in full days are accepted.

        required
        object (ReturnPolicyReturnCost)
        required
        object (ReturnPolicyAddress)
        object (ReturnPolicyContact)
        required
        object (ReturnPolicyOptions)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "availability": {
          },
        • "withdrawalPeriod": "P14D",
        • "returnCost": {
          },
        • "address": {
          },
        • "contact": {
          },
        • "options": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "availability": {
          },
        • "withdrawalPeriod": "P14D",
        • "returnCost": {
          },
        • "address": {
          },
        • "description": "string",
        • "contact": {
          },
        • "options": {
          }
        }

        Get the user's implied warranties

        Use this resource to get seller implied warranties listing. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 60 ]
        Default: 60

        The limit of elements in the response.

        offset
        integer <int32> [ 0 .. 59 ]
        Default: 0

        The offset of elements in the response.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "count": 0,
        • "impliedWarranties": [
          ]
        }

        Create new user's implied warranty

        Use this resource to create an implied warranty definition. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Implied warranty

        name
        string <= 200 characters

        Warranty name.

        object (ImpliedWarrantyPeriod)
        object (ImpliedWarrantyPeriod)
        object (AfterSalesServicesAddress)
        description
        string <= 10240 characters

        Implied warranty description.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "individual": {
          },
        • "corporate": {
          },
        • "address": {
          },
        • "description": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "individual": {
          },
        • "corporate": {
          },
        • "address": {
          },
        • "description": "string"
        }

        Get the user's implied warranty

        Use this resource to get an implied warranty details. Read more: PL / EN.

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

        The ID of the implied warranty.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "individual": {
          },
        • "corporate": {
          },
        • "address": {
          },
        • "description": "string"
        }

        Change the user's implied warranty

        Use this resource to modify the implied warranty details. Read more: PL / EN.

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

        The ID of the implied warranty.

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

        Implied warranty

        name
        string <= 200 characters

        Warranty name.

        object (ImpliedWarrantyPeriod)
        object (ImpliedWarrantyPeriod)
        object (AfterSalesServicesAddress)
        description
        string <= 10240 characters

        Implied warranty description.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "individual": {
          },
        • "corporate": {
          },
        • "address": {
          },
        • "description": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "individual": {
          },
        • "corporate": {
          },
        • "address": {
          },
        • "description": "string"
        }

        Get the user's warranties

        Use this resource to get seller warranties listing. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        limit
        integer <int32> [ 1 .. 60 ]
        Default: 60

        The limit of elements in the response.

        offset
        integer <int32> [ 0 .. 59 ]
        Default: 0

        The offset of elements in the response.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "count": 0,
        • "warranties": [
          ]
        }

        Create new user's warranty

        Use this resource to create a warranty definition. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Warranty

        name
        string <= 200 characters

        Warranty name.

        type
        string (WarrantyType)
        Enum: "MANUFACTURER" "SELLER"

        Defines who is warrantor.

        object (WarrantyPeriod)
        object (WarrantyPeriod)
        object (WarrantyAttachment)
        description
        string <= 10240 characters

        Warranty description.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "type": "MANUFACTURER",
        • "individual": {
          },
        • "corporate": {
          },
        • "attachment": {
          },
        • "description": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "type": "MANUFACTURER",
        • "individual": {
          },
        • "corporate": {
          },
        • "attachment": {
          },
        • "description": "string"
        }

        Get the user's warranty

        Use this resource to get a warranty details. Read more: PL / EN.

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

        The ID of the warranty.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "type": "MANUFACTURER",
        • "individual": {
          },
        • "corporate": {
          },
        • "attachment": {
          },
        • "description": "string"
        }

        Change the user's warranty

        Use this resource to modify the warranty details. Read more: PL / EN.

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

        The ID of the warranty.

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

        Warranty

        name
        string <= 200 characters

        Warranty name.

        type
        string (WarrantyType)
        Enum: "MANUFACTURER" "SELLER"

        Defines who is warrantor.

        object (WarrantyPeriod)
        object (WarrantyPeriod)
        object (WarrantyAttachment)
        description
        string <= 10240 characters

        Warranty description.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "type": "MANUFACTURER",
        • "individual": {
          },
        • "corporate": {
          },
        • "attachment": {
          },
        • "description": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "09f0b4cc-7880-11e9-8f9e-2a86e4085a59",
        • "seller": {
          },
        • "name": "string",
        • "type": "MANUFACTURER",
        • "individual": {
          },
        • "corporate": {
          },
        • "attachment": {
          },
        • "description": "string"
        }

        Create a warranty attachment metadata

        You can attach PDF files to warranties. Uploading attachments flow:

        1. Create an attachment object to receive an upload URL (POST /after-sales-service-conditions/attachments),
        2. Use the upload URL to submit the PDF file (PUT /after-sales-service-conditions/attachments/{attachmentId}),
        3. Create (or update) warranty with attachment (POST /after-sales-service-conditions/warranties).

        Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        After sale services attachment

        name
        string

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "uploaded_file.pdf"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "54702c96-4ccd-4c0e-b4c7-382a71e810b5",
        • "name": "string",
        • "url": "string"
        }

        Upload an warranty attachment

        Upload an after sale services 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 /after-sales-service-conditions/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:settings:write)
        path Parameters
        attachmentId
        required
        string

        The ID of the attachment.

        Request Body schema: application/pdf
        string <binary>

        File in a binary format

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "54702c96-4ccd-4c0e-b4c7-382a71e810b5",
        • "name": "string",
        • "url": "string"
        }

        Delivery

        Get the user's shipping rates

        Use this resource to get a list of seller's shipping rates. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        marketplace
        string
        Example: marketplace=allegro-cz

        Allows to filter shipping rates by marketplace that they are qualified for.

        Responses

        Response samples

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

        Create a new shipping rates set

        Use this resource to create a new seller's shipping rates set. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Shipping rates set

        id
        string

        Shipping rates set ID (UUID) When creating a shipping rates set (Post) the field is ignored. It is required when updating (Put) a shipping rates.

        name
        string [ 1 .. 64 ] characters

        User defined name of the shipping rates set. It may only contain: letters, numbers, hyphens, dots, commas and spaces.

        required
        Array of objects (ShippingRate) [ items ]
        lastModified
        string

        Date and time of the last modification of the set in UTC ISO 8601 format. When creating (Post) or updating (Put) a shipping rates set the field is ignored.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "rates": [
          ],
        • "lastModified": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "rates": [
          ],
        • "lastModified": "string"
        }

        Get the details of a shipping rates set

        Use this resource to get details of the given shipping rates set. Read more: PL / EN.

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

        Shipping rates set identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "758fcd59-fbfa-4453-ae07-4800d72c2ca6",
        • "name": "Mój cennik",
        • "rates": [
          ],
        • "lastModified": "2018-04-05T12:20:23.974Z"
        }

        Edit a user's shipping rates set

        Use this resource to edit a new seller's shipping rates set. Read more: PL / EN.

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

        Shipping rates set identifier.

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

        Shipping rates set

        id
        string

        Shipping rates set ID (UUID) When creating a shipping rates set (Post) the field is ignored. It is required when updating (Put) a shipping rates.

        name
        string [ 1 .. 64 ] characters

        User defined name of the shipping rates set. It may only contain: letters, numbers, hyphens, dots, commas and spaces.

        required
        Array of objects (ShippingRate) [ items ]
        lastModified
        string

        Date and time of the last modification of the set in UTC ISO 8601 format. When creating (Post) or updating (Put) a shipping rates set the field is ignored.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "rates": [
          ],
        • "lastModified": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "rates": [
          ],
        • "lastModified": "string"
        }

        Get the user's delivery settings

        Use this resource to get the delivery settings declared by the seller. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        marketplace.id
        string

        Marketplace for which delivery settings will be returned. By default (if the marketplace parameter is not set) the marketplace on which the seller has registered is used. However, we recommend that the marketplace.id query parameter should always be explicitly set.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "marketplace": {
          },
        • "freeDelivery": {
          },
        • "abroadFreeDelivery": {
          },
        • "joinPolicy": {
          },
        • "customCost": {
          },
        • "updatedAt": "string"
        }

        Modify the user's delivery settings

        Use this resource to modify the delivery settings declared by the seller. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Delivery settings set

        object

        The marketplace for which delivery settings will be modified. By default (if the marketplace parameter is not set) the marketplace on which the seller has registered is used. However, we recommend that the marketplace parameter should always be explicitly set.

        object

        A minimum total order amount required to qualify for free domestic delivery (for example for allegro-cz marketplace, only Czechia is treated as domestic). If you do not want to set free domestic delivery threshold, do not set this value.

        object

        A minimum total order amount required to qualify for free foreign delivery (for example for allegro-cz marketplace, all delivery countries other than Czechia are treated as foreign). If you do not want to set free foreign delivery threshold, do not set this value.

        required
        object

        Policy of calculating delivery costs.

        required
        object

        Policy of custom delivery cost.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "marketplace": {
          },
        • "freeDelivery": {
          },
        • "abroadFreeDelivery": {
          },
        • "joinPolicy": {
          },
        • "customCost": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "marketplace": {
          },
        • "freeDelivery": {
          },
        • "abroadFreeDelivery": {
          },
        • "joinPolicy": {
          },
        • "customCost": {
          },
        • "updatedAt": "string"
        }

        Get the list of delivery methods

        Use this resource to get a list of all delivery methods currently available on the platform, as well as those that have already been discontinued. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        query Parameters
        marketplace
        string
        Example: marketplace=allegro-pl

        Allows to filter delivery methods by marketplace id.

        Responses

        Response samples

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

        Additional services

        Create additional services group

        Use this resource to create a group of additional services. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Additional service group body

        name
        required
        string [ 1 .. 100 ] characters

        Name of the group provided by merchant, invisible for buyers.

        language
        required
        string 5 characters

        IETF language tag. Must be equal to main language for given marketplace: 'pl-PL' on allegro.pl and 'cs-CZ' on allegro.cz while creating new group.
        Cannot change the language of already created group while modifying existing group.

        required
        Array of objects (AdditionalServiceRequest) [ items ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "Gift wrap only",
        • "language": "pl-PL",
        • "additionalServices": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "additionalServices": [
          ],
        • "createdAt": "2019-08-24T14:15:22Z",
        • "id": "string",
        • "updatedAt": "2019-08-24T14:15:22Z",
        • "name": "Gift wrap only",
        • "seller": {
          },
        • "language": "pl-PL"
        }

        Get the user's additional services groups

        Use this resource to retrieve a list of groups with additional services available to a given user which you may assign to offers. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        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
        {
        • "additionalServicesGroups": [
          ]
        }

        Get the additional services definitions by categories

        Use this resource to get additional services definitions, grouped by additional services categories, available on given marketplace. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)

        Responses

        Response samples

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

        Get the details of an additional services group

        Use this resource to get additional services group for a given ID. Read more: PL / EN.

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

        Additional Service Group ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "additionalServices": [
          ],
        • "createdAt": "2019-08-24T14:15:22Z",
        • "id": "string",
        • "updatedAt": "2019-08-24T14:15:22Z",
        • "name": "Gift wrap only",
        • "seller": {
          },
        • "language": "pl-PL"
        }

        Modify an additional services group

        Use this resource to modify existing additional service group. Read more: PL / EN.

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

        Additional service group ID.

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

        Additional service group body

        name
        required
        string [ 1 .. 100 ] characters

        Name of the group provided by merchant, invisible for buyers.

        language
        required
        string 5 characters

        IETF language tag. Must be equal to main language for given marketplace: 'pl-PL' on allegro.pl and 'cs-CZ' on allegro.cz while creating new group.
        Cannot change the language of already created group while modifying existing group.

        required
        Array of objects (AdditionalServiceRequest) [ items ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "Gift wrap only",
        • "language": "pl-PL",
        • "additionalServices": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "additionalServices": [
          ],
        • "createdAt": "2019-08-24T14:15:22Z",
        • "id": "string",
        • "updatedAt": "2019-08-24T14:15:22Z",
        • "name": "Gift wrap only",
        • "seller": {
          },
        • "language": "pl-PL"
        }

        Additional services translations

        Get translations for specified group

        Use this resource to get translations for additional service group. Read more: PL / EN.

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

        Additional Service Group ID.

        query Parameters
        language
        string 5 characters
        Example: language=en-US

        IETF language tag. When provided, the response will contain translations in only that language (if exists).

        Responses

        Response samples

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

        Create/Update translations for specified group and language

        Use this resource to create/update translation for additional service group and specified language. It is allowed to provide an incomplete list of services that belong to the group. Read more: PL / EN.

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

        Additional Service Group ID.

        language
        required
        string 5 characters
        Example: pl-PL

        IETF Language tag.

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

        Additonal service group translation.

        object (AdditionalServicesGroupTranslationWrapper)

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "language": "pl-PL",
        • "additionalServices": {
          }
        }

        Delete a translation for a specified group and language

        Use this resource to delete the translation for specified additional service group and language. Read more: PL / EN.

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

        Additional service group ID.

        language
        required
        string 5 characters
        Example: pl-PL

        IETF Language tag.

        Responses

        Size tables

        Get a size table

        Use this resource to get selected size table. Read more: PL / EN.

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

        Table identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "headers": [
          ],
        • "id": "string",
        • "name": "string",
        • "template": {
          },
        • "values": [
          ]
        }

        Update a size table

        Use this resource to update selected size table. Read more: PL / EN.

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

        Table identifier.

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

        Size table details

        name
        required
        string

        size table name

        required
        Array of objects (Header) [ items ]

        size table headers

        required
        Array of objects (Cells) [ items ]

        size table cells

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "headers": [
          ],
        • "values": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "headers": [
          ],
        • "id": "string",
        • "name": "string",
        • "template": {
          },
        • "values": [
          ]
        }

        Get the user's size tables

        Use this resource to get all size tables assigned to a seller account. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)

        Responses

        Response samples

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

        Create a size table

        Use this resource to create size table. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Size table details

        name
        required
        string

        size table name

        required
        object (JustId)
        required
        Array of objects (Header) [ items ]

        size table headers

        required
        Array of objects (Cells) [ items ]

        size table cells

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "template": {
          },
        • "headers": [
          ],
        • "values": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "headers": [
          ],
        • "id": "string",
        • "name": "string",
        • "template": {
          },
        • "values": [
          ]
        }

        Get the size tables templates

        Use this resource to get all size tables templates. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)

        Responses

        Response samples

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

        Points of service

        Create a point of service

        Use this resource to create a point of service. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        Point of service

        id
        string

        UUID. When creating a point of service (Post) the field is ignored. It is required when updating (Put) a point of service.

        externalId
        string <= 80 characters

        ID from external client system.

        name
        required
        string <= 80 characters
        object (Seller)
        type
        required
        string

        Indicates point type. The only valid value so far is PICKUP_POINT.

        required
        object (Address)
        phoneNumber
        string <= 16 characters
        email
        string <= 64 characters
        Array of objects (PosLocation) [ items ]

        IDs for a location. When creating (Post) or updating (Put) a point of service the field is ignored.

        required
        Array of objects (OpenHour) [ items ]

        Possible empty list of opening hours.

        serviceTime
        string

        Delivery time / Time period for receipt. Date format ISO 8601 e.g. 'PT24H'

        Array of objects (Payment) [ items ]

        An empty list of payment types is available.

        confirmationType
        required
        string

        Confirmation method: AWAIT_CONTACT - We will inform you about the time of receipt, CALL_US - Please make an appointment, CONTACT_NOT_REQUIRED - Contact is not required.

        status
        required
        string

        Point of service status: ACTIVE - active, TEMPORARILY_CLOSED - temporarily closed, CLOSED_DOWN - closed down, DELETED - deleted.

        createdAt
        string

        Creation date. Date format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ When creating (Post) or updating (Put) a point of service the field is ignored.

        updatedAt
        string

        Modification date. Date format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ When creating (Post) or updating (Put) a point of service the field is ignored.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "externalId": "string",
        • "name": "string",
        • "seller": {
          },
        • "type": "string",
        • "address": {
          },
        • "phoneNumber": "string",
        • "email": "string",
        • "locations": [
          ],
        • "openHours": [
          ],
        • "serviceTime": "string",
        • "payments": [
          ],
        • "confirmationType": "string",
        • "status": "string",
        • "createdAt": "string",
        • "updatedAt": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "externalId": "string",
        • "name": "string",
        • "seller": {
          },
        • "type": "string",
        • "address": {
          },
        • "phoneNumber": "string",
        • "email": "string",
        • "locations": [
          ],
        • "openHours": [
          ],
        • "serviceTime": "string",
        • "payments": [
          ],
        • "confirmationType": "string",
        • "status": "string",
        • "createdAt": "string",
        • "updatedAt": "string"
        }

        Get the user's points of service

        Use this resource to get a list of points of service by seller ID. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        seller.id
        required
        string

        User identifier.

        countryCode
        string
        Example: countryCode=PL

        Country code identifier in ISO format. In case of incorrect or unsupported country code, empty list is returned. If missing, list of all defined points is returned. If present, correct and supported, list of all points with given country code for the user is returned.

        Responses

        Response samples

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

        Get the details of a point of service

        Use this resource to get a details of a point of service for a given ID. Read more: PL / EN.

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

        Point of service ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "externalId": "string",
        • "name": "string",
        • "seller": {
          },
        • "type": "string",
        • "address": {
          },
        • "phoneNumber": "string",
        • "email": "string",
        • "locations": [
          ],
        • "openHours": [
          ],
        • "serviceTime": "string",
        • "payments": [
          ],
        • "confirmationType": "string",
        • "status": "string",
        • "createdAt": "string",
        • "updatedAt": "string"
        }

        Modify a point of service

        Use this resource to modify a point of service. Read more: PL / EN.

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

        Point of service ID. Must match values with 'id' property from the body.

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

        Point of service

        id
        string

        UUID. When creating a point of service (Post) the field is ignored. It is required when updating (Put) a point of service.

        externalId
        string <= 80 characters

        ID from external client system.

        name
        required
        string <= 80 characters
        object (Seller)
        type
        required
        string

        Indicates point type. The only valid value so far is PICKUP_POINT.

        required
        object (Address)
        phoneNumber
        string <= 16 characters
        email
        string <= 64 characters
        Array of objects (PosLocation) [ items ]

        IDs for a location. When creating (Post) or updating (Put) a point of service the field is ignored.

        required
        Array of objects (OpenHour) [ items ]

        Possible empty list of opening hours.

        serviceTime
        string

        Delivery time / Time period for receipt. Date format ISO 8601 e.g. 'PT24H'

        Array of objects (Payment) [ items ]

        An empty list of payment types is available.

        confirmationType
        required
        string

        Confirmation method: AWAIT_CONTACT - We will inform you about the time of receipt, CALL_US - Please make an appointment, CONTACT_NOT_REQUIRED - Contact is not required.

        status
        required
        string

        Point of service status: ACTIVE - active, TEMPORARILY_CLOSED - temporarily closed, CLOSED_DOWN - closed down, DELETED - deleted.

        createdAt
        string

        Creation date. Date format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ When creating (Post) or updating (Put) a point of service the field is ignored.

        updatedAt
        string

        Modification date. Date format (ISO 8601) - yyyy-MM-dd'T'HH:mm:ss.SSSZ When creating (Post) or updating (Put) a point of service the field is ignored.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "externalId": "string",
        • "name": "string",
        • "seller": {
          },
        • "type": "string",
        • "address": {
          },
        • "phoneNumber": "string",
        • "email": "string",
        • "locations": [
          ],
        • "openHours": [
          ],
        • "serviceTime": "string",
        • "payments": [
          ],
        • "confirmationType": "string",
        • "status": "string",
        • "createdAt": "string",
        • "updatedAt": "string"
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "externalId": "string",
        • "name": "string",
        • "seller": {
          },
        • "type": "string",
        • "address": {
          },
        • "phoneNumber": "string",
        • "email": "string",
        • "locations": [
          ],
        • "openHours": [
          ],
        • "serviceTime": "string",
        • "payments": [
          ],
        • "confirmationType": "string",
        • "status": "string",
        • "createdAt": "string",
        • "updatedAt": "string"
        }

        Delete a point of service

        Use this resource to delete a point of service. Read more: PL / EN.

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

        Point of service ID.

        Responses

        Response samples

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

        Contacts

        Create a new contact

        Use this resource to create a new contact. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        New contact

        name
        string <= 250 characters
        Array of objects (EmailRequest) <= 1 items [ items ]
        Array of objects (PhonesRequest) <= 2 items [ items ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "emails": [
          ],
        • "phones": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "emails": [
          ],
        • "phones": [
          ]
        }

        Get the user's contacts

        Use this resource to get details of many contacts. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)

        Responses

        Response samples

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

        Get contact details

        Use this resource to get contact details. Read more: PL / EN.

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

        Contact identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "emails": [
          ],
        • "phones": [
          ]
        }

        Modify contact details

        Use this resource to modify contact details. Read more: PL / EN.

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

        Contact identifier.

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

        Contact

        name
        string <= 250 characters
        Array of objects (EmailRequest) <= 1 items [ items ]
        Array of objects (PhonesRequest) <= 2 items [ items ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "string",
        • "emails": [
          ],
        • "phones": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "name": "string",
        • "emails": [
          ],
        • "phones": [
          ]
        }

        Responsible persons

        Get the list of responsible persons

        Use this resource to get a list of responsible persons for the compliance of the product with EU regulations. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)

        Responses

        Response samples

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

        Create responsible person

        Use this resource to create a new responsible person for the compliance of the product with EU regulations. Read more: PL / EN.

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

        Internal name of responsible person in dictionary.

        object

        Responsible person personal data.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "Person responsible for batteries",
        • "personalData": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Person responsible for batteries",
        • "personalData": {
          }
        }

        Update responsible person

        Use this resource to update the responsible person for the compliance of the product with EU regulations. Read more: PL / EN.

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

        Responsible person ID.

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

        Responsible person ID.

        name
        string <= 50 characters

        Internal name of responsible person in dictionary.

        object

        Responsible person personal data.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Person responsible for batteries",
        • "personalData": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Person responsible for batteries",
        • "personalData": {
          }
        }

        Responsible producers

        Get the list of responsible producers

        Use this resource to get a list of responsible producers for the compliance of the product with EU regulations. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        query Parameters
        offset
        integer [ 0 .. 50000 ]
        Default: 0

        Index of first returned responsible producers data from all search results.

        limit
        integer [ 1 .. 1000 ]
        Default: 1000

        Number of returned responsible producers data.

        header Parameters
        Accept
        required
        string
        Example: application/vnd.allegro.public.v1+json

        Acceptable representation of the response.

        Responses

        Response samples

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

        Create responsible producer

        Use this resource to create a new responsible producer for the compliance of the product with EU regulations. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        header Parameters
        Accept
        required
        string
        Example: application/vnd.allegro.public.v1+json

        Acceptable representation of the response.

        Content-Type
        required
        string
        Example: application/vnd.allegro.public.v1+json

        Content type of the request body.

        Request Body schema: application/vnd.allegro.public.v1+json
        name
        string <= 50 characters

        Internal name of responsible producer in dictionary (visible only to you). Can't start or end with whitespace. Can't contain whitespaces other than space. Can't contain multiple spaces in a row.

        object

        Responsible producer data.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "name": "Company responsible for producing product.",
        • "producerData": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Company responsible for producing product.",
        • "producerData": {
          }
        }

        Get responsible producer

        Use this resource to get a responsible producer for the compliance of the product with EU regulations. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:read)
        path Parameters
        id
        required
        string <uuid>

        Responsible producer ID.

        header Parameters
        Accept
        required
        string
        Example: application/vnd.allegro.public.v1+json

        Acceptable representation of the response.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Company responsible for producing product.",
        • "producerData": {
          }
        }

        Update responsible producer

        Use this resource to update the responsible producer for the compliance of the product with EU regulations. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:sale:settings:write)
        path Parameters
        id
        required
        string <uuid>

        Responsible producer ID.

        header Parameters
        Accept
        required
        string
        Example: application/vnd.allegro.public.v1+json

        Acceptable representation of the response.

        Content-Type
        required
        string
        Example: application/vnd.allegro.public.v1+json

        Content type of the request body.

        Request Body schema: application/vnd.allegro.public.v1+json
        id
        string <uuid>

        Responsible producer ID.

        name
        string <= 50 characters

        Internal name of responsible producer in dictionary (visible only to you). Can't start or end with whitespace. Can't contain whitespaces other than space. Can't contain multiple spaces in a row.

        object

        Responsible producer data.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Company responsible for producing product.",
        • "producerData": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "fee43309-8761-43f9-9cfd-a43e539a0fc5",
        • "name": "Company responsible for producing product.",
        • "producerData": {
          }
        }

        Advance Ship Notices

        Get list of Advance Ship Notices

        Use this resource to get a list of Advance Ship Notices. The list is ordered by createdAt property. Default offset is 0, default limit is 50. A list can be filtered by statuses. Multiple status query parameters are allowed. In such cases, filters are joined with OR logical operator. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        query Parameters
        offset
        integer >= 0
        Default: 0

        The offset of elements in the response.

        limit
        integer [ 1 .. 200 ]
        Default: 50

        Maximum number of elements in response.

        status
        Array of strings (AdvanceShipNoticeStatus)
        Items Enum: "DRAFT" "IN_TRANSIT" "UNPACKING" "COMPLETED" "CANCELLED"
        Example: status=DRAFT

        A status of the Advance Ship Notices in the response.

        Responses

        Response samples

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

        Create an Advance Ship Notice

        Use this resource to create an Advance Ship Notice. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:write)
        Request Body schema: application/vnd.allegro.public.v1+json
        required
        Array of objects (ProductItem) [ items ]

        A list of product items.

        object (HandlingUnit)

        Represents information about handling unit.

        object (Shipping)

        Represents information about package shipment. Constraints:

        • for method OWN_TRANSPORT: truckLicencePlate, estimatedTimeOfArrival and countryCode are required.
        • for method COURIER_BY_SELLER: courier, estimatedTimeOfArrival and countryCode are required.
        • for method THIRD_PARTY_DELIVERY: thirdParty, estimatedTimeOfArrival and countryCode are required.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "shipping": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "displayNumber": "A-210310-0000002",
        • "status": "DRAFT",
        • "createdAt": "2020-08-26T12:50:04Z",
        • "updatedAt": "2020-08-26T12:50:04Z",
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "labels": {},
        • "shipping": {
          }
        }

        Get single Advance Ship Notice

        Use this resource to get an Advance Ship Notice. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        path Parameters
        id
        required
        string <uuid>
        Example: 84529ad2-2265-4e15-b76b-c17025d848f6

        The identifier of returned Advance Ship Notice.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "displayNumber": "A-210310-0000002",
        • "status": "DRAFT",
        • "createdAt": "2020-08-26T12:50:04Z",
        • "updatedAt": "2020-08-26T12:52:04Z",
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "labels": {},
        • "shipping": {
          },
        • "submittedAt": "2019-08-24T14:15:22Z"
        }

        Update Advance Ship Notice

        Use this resource to update an Advance Ship Notice. Any content property update will clear labels property. Use Create labels command to create new labels for provided content. If a client wants to update read-only property, an error is returned (only in cases when sent value will be different than actual on the server). Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:write)
        path Parameters
        id
        required
        string <uuid>
        Example: 84529ad2-2265-4e15-b76b-c17025d848f6

        An identifier of Advance Ship Notice.

        header Parameters
        if-match
        required
        string
        Example: 123456

        A current version of Advance Ship Notice (e.g. from etag header obtained via get).

        Request Body schema: application/vnd.allegro.public.v1+json
        required
        Array of objects (ProductItem) [ items ]

        A list of product items.

        object (HandlingUnit)

        Represents information about handling unit.

        object (Shipping)

        Represents information about package shipment. Constraints:

        • for method OWN_TRANSPORT: truckLicencePlate, estimatedTimeOfArrival and countryCode are required.
        • for method COURIER_BY_SELLER: courier, estimatedTimeOfArrival and countryCode are required.
        • for method THIRD_PARTY_DELIVERY: thirdParty, estimatedTimeOfArrival and countryCode are required.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "shipping": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "displayNumber": "A-210310-0000002",
        • "status": "DRAFT",
        • "createdAt": "2020-08-26T12:50:04Z",
        • "updatedAt": "2020-08-26T12:52:04Z",
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "labels": {},
        • "shipping": {
          },
        • "submittedAt": "2019-08-24T14:15:22Z"
        }

        Delete Advance Ship Notice

        Use this resource to delete an Advance Ship Notice. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:write)
        path Parameters
        id
        required
        string <uuid>
        Default: "0b488a23-bc99-470d-8842-0c585adf2479"

        An identifier of the Advance Ship Notice to delete.

        Responses

        Cancel Advance Ship Notice

        Use this resource to cancel an Advance Ship Notice in IN_TRANSIT status. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:write)
        path Parameters
        id
        required
        string <uuid>
        Default: "0b488a23-bc99-470d-8842-0c585adf2479"

        An identifier of the Advance Ship Notice to cancel.

        Responses

        Get labels for Advance Ship Notice

        Use this resource to get labels for Advance Ship Notice after being created with "create labels command". Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        path Parameters
        id
        required
        string <uuid>
        Example: 84529ad2-2265-4e15-b76b-c17025d848f6

        An identifier of the Advance Ship Notice.

        header Parameters
        accept
        required
        string
        Enum: "application/pdf" "x-application/zpl"

        Content-type of generated labels.

        Responses

        Submit the Advance Ship Notice

        Use this resource to submit the Advance Ship Notice. After this operation, updates of the Advance Ship Notice are limited to selected properties only. See PUT /fulfillment/advance-ship-notices/{id}/submitted. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:write)
        path Parameters
        command-id
        required
        string <uuid>
        Default: "725432a9-ae9e-43de-b8c5-7430606a81a4"

        The identifier of the command.

        Request Body schema: application/vnd.allegro.public.v1+json
        id
        string <uuid>

        The identifier of command.

        required
        object (SubmitCommandInput)

        Represents input of the Advance Ship Notice submit command.

        object (SubmitCommandOutput)

        Represents output of the Advance Ship Notice submit command.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "input": {
          },
        • "output": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        running command
        running command
        successful command
        failed command
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "input": {
          },
        • "output": {
          }
        }

        Get submit status

        Use this resource to get submit status of the Advance Ship Notice. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        path Parameters
        command-id
        required
        string <uuid>
        Default: "882202c8-15ab-4a83-aeef-29ea505bf0d0"

        An identifier of the command.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        Example
        running command
        running command
        successful command
        failed command
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "input": {
          },
        • "output": {
          }
        }

        Update submitted Advance Ship Notice

        Use this resource to update already submitted Advance Ship Notice. Update is allowed only when Advance Ship Notice is in "IN_TRANSIT" status. Modifications are limited to:

        • changing items quantity
        • removing items
        • changing handling unit amount
        • changing shipping courier id, name, tracking numbers or vehicle licence plate or third party delivery details (depending on the selected shipping method in the submitted advance ship notice) Handling unit's amount property update clears labels property. Use Create labels command to create new labels for provided content. Read more: PL / EN.
        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:write)
        path Parameters
        id
        required
        string <uuid>
        Example: 84529ad2-2265-4e15-b76b-c17025d848f6

        An identifier of Advance Ship Notice.

        header Parameters
        if-match
        required
        string
        Example: 123456

        A current version of Advance Ship Notice (e.g. from etag header obtained via get).

        Request Body schema: application/vnd.allegro.public.v1+json
        Array of objects (ProductItem) [ items ]

        A list of product items.

        object (UpdateSubmittedHandlingUnitInput)

        Represents information about handling unit.

        object (UpdateSubmittedShippingInput)

        Represents information about package shipment.

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "shipping": {
          }
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "71529ad2-2265-4e15-b76b-c17025d848f7",
        • "displayNumber": "A-210310-0000002",
        • "status": "DRAFT",
        • "createdAt": "2020-08-26T12:50:04Z",
        • "updatedAt": "2020-08-26T12:52:04Z",
        • "items": [
          ],
        • "handlingUnit": {
          },
        • "labels": {},
        • "shipping": {
          },
        • "submittedAt": "2019-08-24T14:15:22Z"
        }

        Check current state and details of Advance Ship Notice receiving

        Use this resource to check the state of Advance Ship Notice receiving in Fulfillment Center in real time. The response contains a receiving progress and information about particular items - their quantities and conditions. While the Advance Ship Notice is in UNPACKING state, report is updated dynamically, which might result in different responses even at short time intervals. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        path Parameters
        id
        required
        string <uuid>
        Default: "712fa46c-7d4a-4ba0-b094-b5d1d4f6155d"

        An identifier of advance ship notice.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "updatedAt": "2020-08-26T12:50:04Z",
        • "stage": "COMPLETED",
        • "displayNumber": "A-210310-0000002",
        • "content": [
          ]
        }

        Fulfillment Stock

        Get available stock

        Use this resource to get a list of the products belonging to the seller, which are in Allegro Warehouse. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        query Parameters
        offset
        integer >= 0
        Default: 0

        The offset of elements in the response. Ignored for text/csv content type.

        limit
        integer [ 1 .. 1000 ]
        Default: 50

        Maximum number of elements in response. Ignored for text/csv content type.

        phrase
        string >= 3 characters

        Filtering search results by product name.

        sort
        string
        Default: "name"
        Enum: "available" "-available" "unfulfillable" "-unfulfillable" "name" "-name" "lastWeekSalesAverage" "-lastWeekSalesAverage" "reserve" "-reserve" "lastThirtyDaysSalesSum" "-lastThirtyDaysSalesSum" "storageFee" "-storageFee"

        Defines how elements are sorted in response. Minus sign can be added to imply descending sort order. Ignored for text/csv content type. Possible values for the "sort" parameter:

        • -available - sorting by quantity of available products (descending)
        • available - sorting by quantity of available products (ascending)
        • -unfulfillable - sorting by quantity of unfulfillable products (descending)
        • unfulfillable - sorting by quantity of unfulfillable products (ascending)
        • -name - sorting by product’s name (descending)
        • name - sorting by product’s name (ascending)
        • lastWeekSalesAverage - sorting by product last week average sales (ascending)
        • -lastWeekSalesAverage - sorting by product last week average sales (descending)
        • reserve - sorting by reserve.outOfStockIn field (ascending)
        • -reserve - sorting by reserve.outOfStockIn field (descending)
        • lastThirtyDaysSalesSum - sorting by product last month sum sales (ascending)
        • -lastThirtyDaysSalesSum - sorting by product last month sum sales (descending)
        • storageFee - sorting by storage fee (ascending). The order by fee status is: NOT_APPLICABLE, then INCLUDED_IN_STORAGE_FEE, then PREDICTION, then CHARGED ordered by amountGross ascending.
        • -storageFee - sorting by storage fee (descending). The order by fee status is: CHARGED ordered by amountGross descending, then PREDICTION, then INCLUDED_IN_STORAGE_FEE, then NOT_APPLICABLE.
        productId
        string <uuid>

        Filtering search results by fulfillment product identifier. Ignored for text/csv content type.

        productAvailability
        Array of strings
        Items Enum: "SUFFICIENT" "UNAVAILABLE" "LOW"

        Filtering search results by availability.

        productStatus
        string
        Value: "UNFULFILLABLE"

        Filtering search results by status.

        storageFee
        string
        Enum: "FREE" "PAID" "TO_BE_PAID_SOON"

        Filtering search results storage fee. Two values are possible: FREE - products storage fee is included in basic fee or merchant is in grace period PAID - products for which an extra storage fee is calculated TO_BE_PAID_SOON - products for which storage will soon be payable.

        asnStatus
        string
        Enum: "SUBMITTED" "NOT_FOUND"

        Filtering search results by ASN status. Following values are allowed: SUBMITTED - Advanced Ship Notice document has been submitted and it contains a particular product. Only the products that have ASN with products on it are returned. NOT_FOUND - Advanced Ship Notice that contains a particular product was not found. It has not been submitted, may be expired, or products have already been delivered to the warehouse. Only the products that don't have related ASN with products on it are returned.

        outOfStockInFrom
        integer

        Filter by products with outOfStockIn greater than or equal.

        outOfStockInTo
        integer

        Filter by products with outOfStockIn less than or equal.

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

        Expected language of product name translation.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        application/vnd.allegro.public.v1+json
        text/csv
        {
        • "stock": [
          ],
        • "count": 1,
        • "totalCount": 10
        }

        Fulfillment Parcels

        Get list of shipped parcels

        Use this resource to get list of parcels and included items for a given order. Items include detailed information such as expiration dates and serial numbers. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        path Parameters
        orderId
        required
        string <uuid>

        The Allegro's platform order identifier.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "orderId": "dd4bbba0-d692-11ec-9eac-2d3687b9fed8",
        • "parcels": [
          ]
        }

        Fulfillment Products

        Get list of available products

        Use this resource to get a list of products that can be added to Advance Ship Notice. The list contains products for which the seller has created offers and is ordered by product's name. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:fulfillment:read)
        query Parameters
        offset
        integer >= 0
        Default: 0

        The offset of elements in the response.

        limit
        integer [ 1 .. 100 ]
        Default: 50

        Maximum number of elements in response.

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

        Expected language of product name translation.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {}

        Information about user

        Get the user's ratings

        Use this resource to receive your sales ratings sorted by last change date, starting from the latest. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:ratings)
        query Parameters
        recommended
        string
        Enum: "true" "false"

        Filter by recommended.

        lastChangedAt.gte
        string <date-time>
        Example: lastChangedAt.gte=2020-11-13T12:45:20.818Z

        Last change (creation or latest edition) date time in ISO 8601 format. The lower bound of date time range from which ratings will be fetched.

        lastChangedAt.lte
        string <date-time>
        Example: lastChangedAt.lte=2020-11-13T12:45:20.818Z

        Last change (creation or latest edition) date time in ISO 8601 format. The upper bound of date time range from which ratings will be fetched.

        offset
        integer <int32> [ 0 .. 20000 ]
        Default: 0

        The offset of elements in the response.

        limit
        integer <int32> [ 1 .. 100 ]
        Default: 20

        The limit of elements in the response.

        Responses

        Response samples

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

        Get the user's rating by given rating id

        Use this resource to receive your sales rating by given rating id. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:ratings)
        path Parameters
        ratingId
        required
        string
        Example: 41846511

        The ID of the rating.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "answer": {
          },
        • "buyer": {
          },
        • "comment": "string",
        • "createdAt": "2017-05-17T08:36:57.292Z",
        • "editedAt": "2017-05-19T08:36:57.292Z",
        • "excludedFromAverageRates": false,
        • "excludedFromAverageRatesReason": "Rating not unique",
        • "id": "string",
        • "lastChangedAt": "2017-05-19T08:36:57.292Z",
        • "order": {
          },
        • "rates": {
          },
        • "recommended": false,
        • "removal": {
          }
        }

        Answer for user's rating

        Use this resource to answer for received rating. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:ratings)
        path Parameters
        ratingId
        required
        string
        Example: 5df0a6d1ef437e00255572a1

        ID of the rating.

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

        User rating answer request.

        message
        required
        string <= 500 characters

        Answer message.

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "createdAt": "2017-05-17T08:36:57.292Z",
        • "message": "string"
        }

        Request removal of user's rating

        Use this resource to request removal of received rating. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:ratings)
        path Parameters
        ratingId
        required
        string
        Example: 5df0a6d1ef437e00255572a1

        ID of the rating.

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

        User rating removal request.

        required
        object

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "possibleTo": "2017-05-17T08:36:57.292Z",
        • "request": {
          }
        }

        Get sales quality

        Use this resource to get current sales quality with at most 30 days history.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:read)

        Responses

        Response samples

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

        Get basic information about user

        Use this resource when you need basic information about authenticated user. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:read)

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "46968690",
        • "login": "Client:46968690",
        • "firstName": "Amadeusz",
        • "lastName": "Iksiński",
        • "email": "user-email@allegro.pl",
        • "baseMarketplace": {
          },
        • "company": {
          },
        • "features": [
          ]
        }

        Get user's additional emails

        Use this resource to get a list of all additional email addresses assigned to account. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:read)

        Responses

        Response samples

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

        Add a new additional email address to user's account

        Use this resource to add a new additional email address to account. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:write)
        Request Body schema: application/vnd.allegro.public.v1+json

        request

        email
        required
        string

        A valid email address you want to add to your account. Maximum length of the part before the @ sign is 64 characters.

        Responses

        Request samples

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

        Response samples

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

        Get information about a particular additional email

        Use this resource to retrieve a single additional email. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:read)
        path Parameters
        emailId
        required
        string

        Id of the additional email.

        Responses

        Response samples

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

        Delete an additional email address

        Use this resource to delete one of additional emails. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:write)
        path Parameters
        emailId
        required
        string

        Id of the additional email to 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"
        }

        Get Smart! seller classification report

        Use this resource to get a full Smart! seller classification report. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:read)
        query Parameters
        marketplaceId
        string
        Example: marketplaceId=allegro-pl

        Marketplace for which seller classification report will be returned. If not specified, the classification result for the seller's registration marketplace will be returned.

        Responses

        Response samples

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

        Information about marketplaces

        Get details for all marketplaces in allegro

        Use this resource to get information about all the marketplaces on the platform. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user

        Responses

        Response samples

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

        Message Center

        List user threads

        Use this resource to get the list of user threads sorted by last message date, starting from newest. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        query Parameters
        limit
        integer <int32> [ 1 .. 20 ]
        Default: 20

        The maximum number of threads returned in the response.

        offset
        integer <int64> [ 0 .. 15000000 ]
        Default: 0

        Index of the first returned thread from all results.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "threads": [
          ],
        • "offset": 0,
        • "limit": 0
        }

        Get user thread

        Use this resource to get thread with provided identifier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        threadId
        required
        string

        Identifier of thread to get.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "read": true,
        • "lastMessageDateTime": "2019-08-24T14:15:22Z",
        • "interlocutor": {
          }
        }

        Mark a particular thread as read

        Use this resource to mark thread with provided identifier as read. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        threadId
        required
        string

        Identifier of thread to be marked.

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

        Updated read flag

        read
        required
        boolean

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "read": true
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "read": true,
        • "lastMessageDateTime": "2019-08-24T14:15:22Z",
        • "interlocutor": {
          }
        }

        Write a new message

        Use this resource to write new message to recipient. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        Request Body schema: application/vnd.allegro.public.v1+json

        Object representing new message.

        required
        object (Recipient)
        text
        required
        string <= 2000 characters
        Array of objects or null (MessageAttachmentId)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "recipient": {
          },
        • "text": "string",
        • "attachments": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "status": "VERIFYING",
        • "type": "MESSAGE_CENTER",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "thread": {
          },
        • "author": {
          },
        • "text": "string",
        • "subject": "string",
        • "relatesTo": {
          },
        • "hasAdditionalAttachments": false,
        • "attachments": [
          ],
        • "additionalInformation": {
          }
        }

        List messages in thread

        Use this resource to list messages in thread with provided identifier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        threadId
        required
        string

        Identifier of thread to get messages from.

        query Parameters
        limit
        integer <int32> [ 1 .. 20 ]
        Default: 20

        The maximum number of messages returned in the response.

        offset
        integer <int64> [ 0 .. 15000 ]
        Default: 0

        Index of the first returned message from all results.

        before
        string <date-time>
        Example: before=2020-11-13T12:45:20.818Z

        Message creation date before filter parameter (exclusive) - cannot be used with offset.

        after
        string <date-time>
        Example: after=2020-11-13T12:45:20.818Z

        Message creation date after filter parameter (exclusive).

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "messages": [
          ],
        • "offset": 0,
        • "limit": 0
        }

        Write a new message in thread

        Use this resource to write new message in existing thread. This resource is rate limited to 1 request per second for a user. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        threadId
        required
        string

        Identifier of thread to write message to.

        Request Body schema: application/vnd.allegro.public.v1+json
        text
        required
        string <= 2000 characters
        Array of objects or null (MessageAttachmentId)

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "text": "string",
        • "attachments": [
          ]
        }

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "status": "VERIFYING",
        • "type": "MESSAGE_CENTER",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "thread": {
          },
        • "author": {
          },
        • "text": "string",
        • "subject": "string",
        • "relatesTo": {
          },
        • "hasAdditionalAttachments": false,
        • "attachments": [
          ],
        • "additionalInformation": {
          }
        }

        Get single message

        Use this resource to get message with provided identifier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        messageId
        required
        string

        Identifier of message to be returned.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "id": "string",
        • "status": "VERIFYING",
        • "type": "MESSAGE_CENTER",
        • "createdAt": "2019-08-24T14:15:22Z",
        • "thread": {
          },
        • "author": {
          },
        • "text": "string",
        • "subject": "string",
        • "relatesTo": {
          },
        • "hasAdditionalAttachments": false,
        • "attachments": [
          ],
        • "additionalInformation": {
          }
        }

        Delete single message

        Use this resource to delete message with provided identifier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        messageId
        required
        string

        Identifier of the message to delete.

        Responses

        Add attachment declaration

        Use this resource to add attachment declaration before uploading. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        Request Body schema: application/vnd.allegro.public.v1+json
        filename
        required
        string
        size
        required
        integer <int64> [ 0 .. 5242880 ]

        Responses

        Request samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "filename": "string",
        • "size": 5242880
        }

        Response samples

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

        Upload attachment binary data

        Use this resource to upload attachment using identifier that was declared. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        attachmentId
        required
        string

        The identifier of attachment that will be uploaded.

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

        File in a binary format

        Responses

        Response samples

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

        Download attachment

        Use this resource to download attachment with provided identifier. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:messaging)
        path Parameters
        attachmentId
        required
        string

        Identifier of the attachment that will be downloaded.

        Responses

        Billing

        Get a list of billing entries

        The billing entries are sorted in a descending order (newest first) by date on which they occurred. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:billing:read)
        query Parameters
        marketplaceId
        string
        Example: marketplaceId=allegro-pl

        The marketplace ID where operation was made. By default the marketplace ID where the user is registered.

        occurredAt.gte
        string <date-time>
        Example: occurredAt.gte=2019-05-08T09:45:32.818Z

        Date from which billing entries are filtered. If occurredAt.lte is also set, occurredAt.gte cannot be later.

        occurredAt.lte
        string <date-time>
        Example: occurredAt.lte=2019-05-08T09:45:32.818Z

        Date to which billing entries are filtered. If occurredAt.gte is also set, occurredAt.lte cannot be earlier.

        type.id
        Array of strings
        Example: type.id=LIS&type.id=SUC

        List of billing types by which billing entries are filtered.

        offer.id
        string
        Example: offer.id=12345

        Offer ID by which billing entries are filtered.

        order.id
        string <uuid>
        Example: order.id=29738e61-7f6a-11e8-ac45-09db60ede9d6

        Order UUID by which billing entries are filtered.

        limit
        integer <int32> [ 1 .. 100 ]
        Default: 100
        Example: limit=10

        Number of returned operations.

        offset
        integer <int32> [ 0 .. 10000 ]
        Default: 0
        Example: offset=10

        Index of the first returned payment operation from all search results.

        Responses

        Response samples

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

        Get a list of billing types

        List of all billing types. Type names are localized according to "Accept-Language" header. Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        header Parameters
        Accept-Language
        string <string>
        Example: pl-PL

        Expected language of name translations.

        Responses

        Response samples

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

        Auctions and Bidding

        Place a bid in an auction

        Place a bid in an auction. Read more: PL / EN.

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

        The offer ID.

        Request Body schema: application/vnd.allegro.public.v1+json
        required
        object (MaxPrice)

        Maximum amount that user is willing to pay for the auction.

        Responses

        Request samples

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

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "maxAmount": {
          },
        • "minimalPriceMet": true,
        • "highBidder": true,
        • "auction": {
          }
        }

        Get current user's bid information

        Get current user's bid information. Read more: PL / EN.

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

        The offer ID.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "maxAmount": {
          },
        • "minimalPriceMet": true,
        • "highBidder": true,
        • "auction": {
          }
        }

        Charity

        Search fundraising campaigns

        Use this resource to search fundraising campaigns. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user
        query Parameters
        limit
        required
        integer <int32> [ 1 .. 100 ]

        Maximum number of returned results.

        phrase
        required
        string

        Fundraising campaign name or it's Organization name prefix to search for.

        Responses

        Response samples

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

        Public user information

        Get any user's ratings summary

        Use this resource to receive feedback statistics. Read more: PL / EN.

        Authorizations:
        bearer-token-for-user (allegro:api:profile:read)
        path Parameters
        userId
        required
        string
        Example: 41846511

        The ID of the user.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "averageRates": {
          },
        • "notRecommended": {
          },
        • "recommended": {
          },
        • "recommendedPercentage": "99,8"
        }

        Public offer information

        Search offers

        Access for verified applications only. Use this resource to get a list of offers based on the provided query parameters. At least one of: phrase, seller.id or category.id is required. Additional available parameters vary depending on category.id. The parameters are defined in the filters entity. Changing the marketplace, country of delivery, currency or language may impact the availability of offers and filters. Note that requests for closed offers and searching by descriptions may be limited.

        Read more: PL / EN.

        Authorizations:
        bearer-token-for-applicationbearer-token-for-user
        query Parameters
        category.id
        string

        The identifier of the category, where you want to search for offers.

        phrase
        string

        The search phrase. The phrase is searched in different fields of the offers depending on the value of the searchMode parameter.

        seller.id
        string

        The identifier of a seller, to limit the results to offers from this seller. May be provided more than once. Should not be provided when seller.login is given.

        seller.login
        string

        The login of a seller, to limit the results to offers from this seller. May be provided more than once. Should not be provided when seller.id is given.

        marketplaceId
        string
        Default: "allegro-pl"

        Id of a marketplace where offers are visible. Acceptable values : allegro-pl, allegro-cz, allegro-sk.

        shipping.country
        string
        Example: shipping.country=PL

        Limits the result to offers with specified delivery country. Default value : depends on marketplace, for allegro-pl: PL, for allegro-cz: CZ, for allegro-sk: SK. Check endpoint GET /marketplaces for acceptable values.

        currency
        string <ISO 4217 currency code>
        Example: currency=PLN

        Currency of the offer prices. Default value : depends on marketplace, for allegro-pl: PLN, for allegro-cz: CZK, for allegro-sk: EUR. Check endpoint GET /marketplaces for acceptable currency values.

        searchMode
        string
        Default: "REGULAR"
        Enum: "REGULAR" "DESCRIPTIONS" "CLOSED"

        Defines where the given phrase should be searched in. Allowed values:

        • REGULAR - searching for a phrase in the title,
        • DESCRIPTIONS - searching for a phrase in the title and the descriptions,
        • CLOSED - searching for a phrase in the title of closed offers. Available only for allegro-pl marketplace.
        offset
        integer [ 0 .. 599 ]
        Default: 0

        Index of the first returned offer from all search results. Max offset is 600 - <limit>.

        limit
        integer [ 1 .. 60 ]
        Default: 60

        The maximum number of offers in a response.

        sort
        string
        Default: "relevance"
        Enum: "relevance" "+price" "-price" "+withDeliveryPrice" "-withDeliveryPrice" "+endTime" "-startTime"

        Search results sorting order. + or no prefix in the value means ascending order. - prefix means descending order.

        include
        string

        Specify parts of the response that should be included in the output. Allowed values are the names of top level entities and all as an alias to all entities. By default, all top level entities are included. Use - prefix to exclude an entity. Example: include=-all&include=filters&include=sort - returns only filters and sort entities.

        fallback
        boolean
        Default: true

        Defines the behaviour of the search engine when no results with exact phrase match are found:

        • true - related (not exact) results are returned,
        • false - empty results are returned.
        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": "parameter.11323",
    "type": "MULTI",
    "name": "Stan",
    "values": [{
        "value": "11323_1",
        "name": "nowe",
        "count": 21,
        "selected": false
      },
      {
        "value": "11323_2",
        "name": "używane",
        "count": 157,
        "selected": false
      },
      {
        "value": "11323_238066",
        "name": "po zwrocie",
        "count": 1,
        "selected": false
      }
    ]
  }

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

        • parameter.11323=11323_1 for "nowe"
        • parameter.11323=11323_2 for "używane"
        • parameter.11323=11323_238066 for "po zwrocie".
        header Parameters
        Accept-Language
        string <BCP-47 language code>
        Example: pl-PL

        Limits offers to the only translated to specified language. Also expected language of messages. Default value : depends on marketplace, for allegro-pl: pl-PL, for allegro-cz: cs-CZ, for allegro-sk: sk-SK. Check endpoint GET /marketplaces for acceptable language values.

        Responses

        Response samples

        Content type
        application/vnd.allegro.public.v1+json
        {
        • "items": {
          },
        • "categories": {
          },
        • "filters": [
          ],
        • "searchMeta": {
          },
        • "sort": [
          ]
        }
        Allegro
        zamknij

        Dostosuj ustawienia wyświetlania

        ustawienia dotyczą tylko tej przeglądarki