stock

The stock resource represents a quantity of a product (SKU) at a stockLocation. The stock itself may carry some properties.

idinteger

Example: 654322

typestring

Example: stock

attributes object

skuproductSku

SKU (stock keeping unit) of a product used to identify products.

Possible values: >= 2 characters and <= 80 characters, Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:

Example 1
Example 2
Example 3
Example 4
Example 5

Example: TSH-000-S

Example: 8720874770299

Example: HK-HNTSSTNG 6X

Example: BK-14-LARGE: 31x41x14

Example: TRRE-PSU6*003;2023-10:special

quantityinteger

Possible values: > 0

locationTypelocationType

The locationType indicates the (general) usage of the location of physical stock.

All locations have been classified to the one of the following types:

value	description
AUTOSTORE	An autostore location, which is a special type of PICKABLE location
PICKABLE	A location from which stock can be picked, but different than AUTOSTORE
PALLET	A storage location, not directly used for picking
INBOUND	A temporary location used for new SKUs
RETURN	A temporary location for returned SKUs
TRANSFER	A temporary location used to transfer stock in or between warehouses
SECURED	Special secured storage
COOLED	Special cooled storage
OUTBOUND	Location used in case of outbounds other than regular shipments
SPECIAL	Special purpose locations
INSERTS	Special purpose location for inserts (e.g. flyers)
DAMAGED	Special purpose location for damaged goods that need to be shipped to a refurbishment party
TO_SCRAP	Special purpose location for scrapped goods that remain in the warehouse until a destruction order is received.

Possible values: [PALLET, SPECIAL, PICKABLE, COOLED, INBOUND, OUTBOUND, RETURN, TRANSFER, SECURED, AUTOSTORE, DAMAGED, TO_SCRAP, INSERTS]

locationCodestockLocationCode

The stockLocationCode defines a location uniquely within a warehouse. This means that the code may appear in other warehouses as well with the exception of the locations of type TRANSFER which operate between warehouses.

Examples:

Example: ZAB06E

Example: ZAQ29A

Example: 26160-22

Example: ZAC21A0

Example: 64755-11

Example: 36547-42

Example: 19251-44

Example: 33769-42

Example: 25298-11

Example: 16490-11

qualitystockQuality

An enumerated value indicating the quality of stock.

The following qualities exists:

quality	description
`OK`	The `SKU` of this `stock` is not damaged in any form and could be sold.
`DAMAGED`	The `SKU` of this `stock` is damaged and requires refurbishment. Typical occurs when returned items are stained or otherwise damaged.
`TO_SCRAP`	The `SKU` of this `stock` is damaged beyond repair and can no longer be sold.
`OVERDUE`	The `SKU` of this `stock` is past its sell-by date and may no longer be sold.
`EXPIRED`	The `SKU` of this `stock` is expired and can no longer be sold.

Possible values: [OK, DAMAGED, TO_SCRAP, OVERDUE, EXPIRED]

Default value: OK

Example: DAMAGED

statusstockStatus

An enumerated value indicating the status of stock.

The following qualities exists:

status	description
`OK`	The `stock` is ok and can be sold/moved or used.
`NOL_CHECK`	A deviation in `quantity` has been detected and the `stock` must be recounted before it can be used.
`INBOUND`	The `stock` is involved in an `inbound` which is not complete yet.
`INBOUND_RECOUNT`	The `stock` is involved in an `inbound` and a difference between the `inboundPackingSlip` and the `inbound` causes the `stock` to be recounted.
`RECOUNT_REQUESTED`	The `stock` is to be recounted on request.
`BARCODE_NOT_SCANNABLE`	The `stock` could not be picked due to barcode issues and must be investigated.

Possible values: [OK, NOL_CHECK, INBOUND, INBOUND_RECOUNT, RECOUNT_REQUEST, BARCODE_NOT_SCANNABLE]

Default value: OK

Example: INBOUND

expirationDatestring<date>

When the products at this locatoin have the same expiration date then this is reflected by this field. As a rule, products with different expiration dates cannot be kept in the same location.

expirationStatusexpirationStatus

The expirationStatus shows if the expirationDate of the stock is within certain limits or has expired. The following statuses exists:

status	description
`OK`	The `stock` is well before the sell-by date or does not expire.
`WARNING`	The `stock` is within the margin before it reaches the sell-by date, but has not crossed the sell-by date. The margin for this warning is set by the field `expirationDateWarning` on the `product`.
`OVERDUE`	The `stock` has technically not expired, but can no longer be sold to consumers. It is now excluded from being shipped. The margin for this date is set by the field `expirationDateMargin` on the `product`.
`EXPIRED`	The `stock` has actually expired, i.e. the `expirationDate` of this stock lies in the past.

Possible values: [OK, WARNING, OVERDUE, EXPIRED]

Default value: OK

Example: OVERDUE

lotNumberlotNumber

Specifies the lot number of the SKU at this location. This value is only provided if all items at this location share the same lot number. It is not possible to keep sku having different lot numbers at the same location.

Possible values: Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:

Example 1
Example 2

Example: M008686

Example: M-45/61 21-190

quarantinedboolean

Indicates that this particular stock is in quarantine. Stock that i placed in quarantine is excluded from many regular processes to prevent it from being shipped.

Default value: false

modifiedOnstring<date-time>

receivedOnstring<date>

Specifies when the items in this stock were first received.

Example: 2022-02-14

relationships object

stockLocation object

Represents a relationship to a stockLocation resource.

data object

Identifies a resource as stockLocation.

idinteger

Example: 1008713

type

Constant value: stockLocation

Default value: stockLocation

product object

Represents a relationship to a product resource.

data object

Represents a self-link of a product resource.

idinteger

The id is an internally assigned id of a product. It is possible to assign an arbitrary value in a POST request to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 1267733

type

Constant value: product

Default value: product

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/products/1267733

inboundItem object

Points to the last inboundItem resource that increased the quantity of this stock.

data object

Represents a relationship to an inbound resource.

idinteger

Example: 673333

type

Constant value: inboundItem

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/inboundItems/673333

included object[]

Array [

anyOf

stockLocationAttributes

Representes the attributes of the stockLocation resource.

idinteger

Example: 1008713

type

Constant value: stockLocation

Default value: stockLocation

attributes object

warehouseCodewarehouseCode

The code for the warehouse used to uniquely refer to an Paxon warehouse.

The following warehouses are currently defined:

code	country	city	customs region	remarks
BW	Belgium	Willebroek	EU - Common Customs Tariff
DD	Germany	Dorsten	EU - Common Customs Tariff
FL	France	Lyon	EU - Common Customs Tariff
FP	France	Pantin	EU - Common Customs Tariff	return hub only
GN	Great Brittain	Northampton	GB - UK Global Tariff
NN	The Netherlands	Nieuwegein	EU - Common Customs Tariff	discontinued
NR	The Netherlands	Roosendaal	EU - Common Customs Tariff

Possible values: [BW, DD, FL, FP, GN, NR]

locationTypelocationType

The locationType indicates the (general) usage of the location of physical stock.

All locations have been classified to the one of the following types:

value	description
AUTOSTORE	An autostore location, which is a special type of PICKABLE location
PICKABLE	A location from which stock can be picked, but different than AUTOSTORE
PALLET	A storage location, not directly used for picking
INBOUND	A temporary location used for new SKUs
RETURN	A temporary location for returned SKUs
TRANSFER	A temporary location used to transfer stock in or between warehouses
SECURED	Special secured storage
COOLED	Special cooled storage
OUTBOUND	Location used in case of outbounds other than regular shipments
SPECIAL	Special purpose locations
INSERTS	Special purpose location for inserts (e.g. flyers)
DAMAGED	Special purpose location for damaged goods that need to be shipped to a refurbishment party
TO_SCRAP	Special purpose location for scrapped goods that remain in the warehouse until a destruction order is received.

Possible values: [PALLET, SPECIAL, PICKABLE, COOLED, INBOUND, OUTBOUND, RETURN, TRANSFER, SECURED, AUTOSTORE, DAMAGED, TO_SCRAP, INSERTS]

locationCodestockLocationCode

Examples:

Example: ZAB06E

Example: ZAQ29A

Example: 26160-22

Example: ZAC21A0

Example: 64755-11

Example: 36547-42

Example: 19251-44

Example: 33769-42

Example: 25298-11

Example: 16490-11

]

links object

selfstring

Example: https://shopapi.activeants.nl/v3/stock/654322

stock
{
  "id": 654322,
  "type": "stock",
  "attributes": {
    "sku": "TSH-000-S",
    "quantity": 0,
    "locationType": "PALLET",
    "locationCode": "ZAB06E",
    "quality": "DAMAGED",
    "status": "INBOUND",
    "expirationDate": "2024-07-29",
    "expirationStatus": "OVERDUE",
    "lotNumber": "M008686",
    "quarantined": false,
    "modifiedOn": "2024-07-29T15:51:28.071Z",
    "receivedOn": "2022-02-14"
  },
  "relationships": {
    "stockLocation": {
      "data": {
        "id": 1008713
      }
    },
    "product": {
      "data": {
        "id": 1267733,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/products/1267733"
        }
      }
    },
    "inboundItem": {
      "data": {
        "id": 673333,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/inboundItems/673333"
        }
      }
    }
  },
  "included": [
    {
      "id": 1008713,
      "attributes": {
        "warehouseCode": "BW",
        "locationType": "PALLET",
        "locationCode": "ZAB06E"
      }
    }
  ],
  "links": {
    "self": "https://shopapi.activeants.nl/v3/stock/654322"
  }
}