Documentation

List of resources available in Allegro REST API.

Allegro REST API

Authentication
Offer
- User's offer information
  - getGet seller's offers
  - getGet all fields of the particular offer
  - getGet events about the seller's offers
- Offer management
  - putModify the Buy Now price in an offer
  - postCreate a draft offer
  - putComplete a draft offer or edit an offer
  - delDelete a draft offer
  - putBatch offer publish / unpublish
  - getPublish command summary
  - getPublish command detailed report
  - getGet all available offer promotion packages
  - postModify offer promotion packages
  - getGet offer promotion packages
  - putBatch offer promotion package modification
  - getModification command summary
  - getModification command detailed result
  - postCreate offer based on product
  - patchEdit an offer
  - getGet all data of the particular product-offer
  - getCheck the processing status of a POST or PATCH request
  - getGet offers with missing parameters
- Categories and parameters
  - getGet IDs of Allegro categories
  - getGet a category by ID
  - getGet parameters supported by a category
  - getGet planned changes in category parameters
  - getGet changes in categories
  - getGet categories suggestions
- Images and attachments
  - postUpload an offer image
  - postCreate an offer attachment
  - putUpload an offer attachment
- Products
  - getGet product parameters available in given category
  - getGet search products results
  - getGet all data of the particular product
  - postPropose a product
- Batch offer modification
  - putBatch offer modification
  - getModification command summary
  - getModification command detailed report
  - putBatch offer price modification
  - getChange price command summary
  - getChange price command detailed report
  - putBatch offer quantity modification
  - getChange quantity command summary
  - getChange quantity command detailed report
- Offer variants
  - postCreate variant set
  - getGet the user's variant sets
  - putUpdate variant set
  - getGet a variant set
  - delDelete a variant set
- Offer tags
  - postCreate a tag
  - getGet the user's tags
  - delDelete a tag
  - putModify a tag
  - postAssign tags to an offer
  - getGet tags assigned to an offer
- Tax settings
  - getGet all tax settings for category
- Compatibility List
  - getGet list of categories where compatibility list is supported
  - getGet suggested compatibility list.
  - getGet list of compatible product groups
  - getGet list of compatible products
- Rebates and promotions
  - postCreate a new promotion
  - getGet the user's list of promotions
  - getGet a promotion data by id
  - putModify a promotion
  - delDeactivate a promotion by id
- Promotion campaigns
  - postCreate an application for a promotion campaign
  - getGet the user's promotion campaigns
  - delDelete a campaign in a promotion
  - getGet an application for promotion campaign
  - delDelete an application for promotion campaign
- Badge campaigns
  - get[BETA] Get a list of available badge campaigns
  - post[BETA] Apply for badge in selected offer
  - get[BETA] Get a list of badges
  - get[BETA] Get a badge application details
  - get[BETA] Get a list of badge applications
  - get[BETA] Get badge operation details
  - patch[BETA] Update campaign badge for the given offer
- Allegro Prices
  - getGet the current consent value for an offer
  - putUpdate consent value for an offer
  - getGet the current eligibility information for the account
  - putUpdate consent value for the account
- Offer rating
  - getGet offer rating
- Classifieds
  - getGet classified packages assigned to an offer
  - putAssign packages to a classified
  - getGet configurations of packages
  - getGet the configuration of a package
- Pricing
  - postPreview offer fees
  - postCalculate fee and commission for an offer
  - getGet the user's current offer quotes
Orders
- Order management
  - getGet order events
  - getGet order events statistics
  - getGet the user's orders
  - getGet an order's details
  - getGet a list of available shipping carriers
  - getGet a list of parcel tracking numbers
  - postAdd a parcel tracking number
  - putSet seller order status
  - getGet order invoices details
  - postPost new invoice
  - putUpload invoice file
  - getGet Allegro pickup drop off points
  - getGet Allegro parcel tracking history
- Payments
  - getPayment operations history
  - postInitiate a refund of a payment
  - getGet a list of refunded payments
- Disputes
  - getGet the user's disputes
  - getGet a single dispute
  - getGet the messages within a dispute
  - postAdd a message to a dispute
  - postCreate an attachment declaration
  - putUpload a dispute message attachment
  - getGet an attachment
- Parcel management
  - getGet available delivery services
  - putCreate a new parcel
  - getGet parcel creation status
  - getGet parcel details
  - getGet parcels pickup date proposals
  - putRequest parcel pickup
  - getGet parcel pickup status
  - getGet parcel label
  - getGet parcels protocol
  - putCancel parcel
  - getGet parcel cancellation status
- Customer returns
  - get[BETA] Get customer returns by provided query parameters
  - get[BETA] Get customer return by id
  - post[BETA] Reject customer return refund
- Commission refunds
  - getGet a refund application details
  - delCancel a refund application
  - getGet a list of refund applications
  - postCreate a refund application
- Blacklist management
  - getGet list of blacklisted users
  - postAdd a users to the blacklist
  - delRemove users from the blacklist
Sale settings
- After sale services
  - getGet the user's return policies
  - postCreate new user's return policy
  - getGet the user's return policy
  - putChange the user's return policy
  - getGet the user's implied warranties
  - postCreate new user's implied warranty
  - getGet the user's implied warranty
  - putChange the user's implied warranty
  - getGet the user's warranties
  - postCreate new user's warranty
  - getGet the user's warranty
  - putChange the user's warranty
  - postCreate a warranty attachment metadata
  - putUpload an warranty attachment
- Delivery
  - getGet the user's shipping rates
  - postCreate a new shipping rates set
  - getGet the details of a shipping rates set
  - putEdit a user's shipping rates set
  - getGet the user's delivery settings
  - putModify the user's delivery settings
  - getGet the list of delivery methods
  - get[BETA] Get shipping rates assigned to an offer
- Additional services
  - postCreate additional services group
  - getGet the user's additional services groups
  - getGet the user's additional services definitions
  - getGet the details of an additional services group
  - putModify an additional services group
- Size tables
  - getGet a size table
  - putUpdate a size table
  - getGet the user's size tables
  - postCreate a size table
  - getGet the size tables templates
- Points of service
  - postCreate a point of service
  - getGet the user's points of service
  - getGet the details of a point of service
  - putModify a point of service
  - delDelete a point of service
- Contacts
  - postCreate a new contact
  - getGet the user's contacts
  - getGet contact details
  - putModify contact details
Others
- Information about user
  - getGet the user's ratings
  - putAnswer for user's rating
  - putRequest removal of user's rating