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: <a href="../../tutorials/one-fulfillment-by-allegro-0ADwgOLqWSw#jak-pobrac-aktualne-stany-magazynowe" target="_blank">PL</a> / <a href="../../tutorials/one-fulfillment-by-allegro-4R9dXyMPlc9#get-available-stock" target="_blank">EN</a>.

get/fulfillment/stock

Request

  • Base URL: https://api.allegro.pl
  • URL: https://api.allegro.pl/fulfillment/stock
  • Auth: OAuth 2 (authorization code, authorization URL https://allegro.pl/auth/oauth/authorize, token URL https://allegro.pl/auth/oauth/token, scopes: allegro:api:fulfillment:read)

Query parameters

offsetinteger

The offset of elements in the response. Ignored for text/csv content type.

limitinteger

Maximum number of elements in response. Ignored for text/csv content type.

phrasestring

Filtering search results by product name.

sort'available' | '-available' | 'unfulfillable' | '-unfulfillable' | 'name' | '-name' | 'lastFourteenDaysSalesAverage' | '-lastFourteenDaysSalesAverage' | '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)
  • lastFourteenDaysSalesAverage - sorting by product last fourteen days average sales (ascending)
  • -lastFourteenDaysSalesAverage - sorting by product last fourteen days 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 CHARGED ordered by amountGross ascending.
  • -storageFee - sorting by storage fee (descending). The order by fee status is: CHARGED ordered by amountGross descending, then NOT_APPLICABLE.
productIdstring uuid

Filtering search results by fulfillment product identifier. Ignored for text/csv content type.

productAvailabilitystring[]

Filtering search results by availability.

productStatus'UNFULFILLABLE'

Filtering search results by status.

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

outOfStockInFrominteger

Filter by products with outOfStockIn greater than or equal.

outOfStockInTointeger

Filter by products with outOfStockIn less than or equal.

Headers

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

Expected language of messages.

Response

Returns available stock for the seller.

Changes

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