Manage orders - Check Inventory

Retrieves inventory validation results for the provided country.

POST https://api.partnercenter.microsoft.com/v{version}/extensions/product/checkinventory
POST https://api.partnercenter.microsoft.com/v{version}/extensions/product/checkinventory?country={country}

URI Parameters

Name In Required Type Description
version
path True

string

country
query

string

The country information. Two letter representation of country

Request Header

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name Required Type Description
Authorization True

string

Authorization Bearer token

ms-correlationid

string

Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request

MS-CV

string

Used for tracking requests internally. If a MS-CV is not provided, the server will generate a new one for each request

ms-requestid

string

Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name Type Description
inventoryCheckRequest

Contracts.V1.Models.InventoryCheckRequest

The inventory check request.

Responses

Name Type Description
200 OK

Contracts.V1.Models.InventoryItem[]

The request was successful. The inventory results are returned in the response body.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
Contracts.V1.Models.InventoryCheckRequest

The inventory check request.

Contracts.V1.Models.InventoryItem
Contracts.V1.Models.InventoryRestriction

Contracts.V1.Models.InventoryCheckRequest

The inventory check request.

Name Type Description
inventoryContext

object

targetItems

Contracts.V1.Models.InventoryItem[]

Contracts.V1.Models.InventoryItem

Name Type Description
isRestricted

boolean

productId

string

restrictions

Contracts.V1.Models.InventoryRestriction[]

skuId

string

Contracts.V1.Models.InventoryRestriction

Name Type Description
description

string

properties

object

reasonCode

string