Order management

Get the user's orders

Use this resource to get an order list. Read more: <a href="../../tutorials/jak-obslugiwac-zamowienia-GRaj0qyvwtR#lista-zamowien" target="_blank">PL</a> / <a href="../../tutorials/process-orders-PgPMlWDr8Cv#order-list" target="_blank">EN</a>.

get/order/checkout-forms

Request

  • Base URL: https://api.allegro.pl
  • URL: https://api.allegro.pl/order/checkout-forms
  • Auth: OAuth 2 (authorization code, authorization URL https://allegro.pl/auth/oauth/authorize, token URL https://allegro.pl/auth/oauth/token, scopes: allegro:api:orders:read)

Query parameters

offsetinteger

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

limitinteger

Maximum number of checkout-forms in response.

statusstring

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.statusstring

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
  • RETURNED.
fulfillment.provider.idstring

Specify filter for order management provider. Allowed values are:

  • SELLER: for orders managed directly by seller
  • ALLEGRO: for orders managed by Allegro warehouse (One Fulfillment).
fulfillment.shipmentSummary.lineItemsSentstring

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.ltestring date-time

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

lineItems.boughtAt.gtestring date-time

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

payment.idstring

Find checkout-forms having specified payment id.

surcharges.idstring

Find checkout-forms having specified surcharge id.

delivery.method.idstring

Find checkout-forms having specified delivery method id.

buyer.loginstring

Find checkout-forms having specified buyer login.

marketplace.idstring

Find checkout-forms of orders purchased on specified marketplace.

updatedAt.ltestring date-time

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

updatedAt.gtestring date-time

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

sort'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.

Headers

Accept-Language'en-US' | 'pl-PL' | 'uk-UA' | 'sk-SK' | 'cs-CZ' | 'hu-HU' BCP-47 language code

Expected language of messages.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.