This call is used to get a list of Channel products for the purpose of mapping. This call is usually scheduled every 12 hours unless a customer requests it to be run sooner.

Quantity is a required field as Linnworks will check this on the product call to ensure the last submitted quantity is the same, if it's not then we will initiate a re-sync.

Request

Post

`ProductsRequest`

Field Name	Type	Description
AuthorizationToken	`String`	Authorization Token from the customers integration.
PageNumber	`Int`	Current page number in the fetch sequence, starts from 1.

Sample

{
  "AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148",
  "PageNumber": 1
}

Response

`ProductsResponse`

Field Name	Type	Description
Error	`String`	If there was an error with the request. In the cases where there are no products or no more products on the call, return `HasMorePages` as `false` instead of returning an error.
HasMorePages	`Boolean`	Indicates if more pages are expected, if true then Linnworks will increment the page call and call again.
Products	`Product[]`	Array of products returned from the channel. See Product table.

`Product`

Field Name	Type	Description
SKU Required	`String`	Product Unique SKU, duplicates are not allowed.
Title Required	`String`	Title of the product.
Quantity Required	`Int`	Current quantity / stock level on the channel.
Price	`Decimal`	Current price on the channel.
Reference Required	`String`	Reference from the channel e.g. internal product ID. This will be submitted alongside the SKU in inventory and price updates. If there is no reference then supply SKU Limit 64 Chars

Sample

{
	"Error": null,
	"HasMorePages": true,
	"Products": [
		{
			"SKU": "ChannelProduct_1",
			"Title": "Channel Tile of product ChannelProduct_1",
			"Quantity": 68,
			"Price": 9.15,
			"Reference": "12458"
		},
		{
			"SKU": "ChannelProduct_2",
			"Title": "Channel Tile of product ChannelProduct_2",
			"Quantity": 22,
			"Price": 0.99,
			"Reference": "987653"
		}
	]
}

{
	"Error": "Auth token is not valid.",
	"HasMorePages": true,
	"Products": []
}