Vendor Direct Fulfillment Inventory API v1 reference

AmazonSPAPI

# Overview

The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor's inventory updates.

# Version information

Version : v1

# Operations

submitInventoryUpdate

# Paths

# submitInventoryUpdate

POST /vendor/directFulfillment/inventory/v1/warehouses/{warehouseId}/items

# Description

Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

# Parameters

Type Name Description Schema
Body body
required
The request body for the submitInventoryUpdate operation. SubmitInventoryUpdateRequest
Path warehouseId
required
Identifier for the warehouse for which to update inventory. string

# Responses

HTTP Code Description Schema
202 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
SubmitInventoryUpdateResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

# Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code Description Schema
400 Request has missing or invalid parameters and cannot be parsed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
403 Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
404 The resource specified does not exist.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
413 The request size exceeded the maximum accepted size.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
415 The request payload is in an unsupported format.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
429 The frequency of requests was greater than allowed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse
503 Temporary overloading or maintenance of the server.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
SubmitInventoryUpdateResponse

# Definitions

# SubmitInventoryUpdateRequest

The request body for the submitInventoryUpdate operation.

Name Description Schema
inventory
optional
Inventory details required to update some or all items for the requested warehouse. InventoryUpdate

# InventoryUpdate

Name Description Schema
sellingParty
required
ID of the selling party or vendor. PartyIdentification
isFullUpdate
required
When true, this request contains a full feed. Otherwise, this request contains a partial feed. When sending a full feed, you must send information about all items in the warehouse. Any items not in the full feed are updated as not available. When sending a partial feed, only include the items that need an update to inventory. The status of other items will remain unchanged. boolean
items
required
A list of inventory items with updated details, including quantity available. < ItemDetails > array

# ItemDetails

Updated inventory details for an item.

Name Description Schema
buyerProductIdentifier
optional
The buyer selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted. string
vendorProductIdentifier
optional
The vendor selected product identification of the item. Either buyerProductIdentifier or vendorProductIdentifier should be submitted. string
availableQuantity
required
Total item quantity available in the warehouse. ItemQuantity
isObsolete
optional
When true, the item is permanently unavailable. boolean

# PartyIdentification

Name Description Schema
partyId
required
Assigned identification for the party. string

# ItemQuantity

Details of item quantity.

Name Description Schema
amount
optional
Quantity of units available for a specific item. integer
unitOfMeasure
required
Unit of measure for the available quantity. string

# SubmitInventoryUpdateResponse

The response schema for the submitInventoryUpdate operation.

Name Description Schema
payload
optional
The response payload for the submitInventoryUpdate operation. TransactionReference
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# TransactionReference

Name Description Schema
transactionId
optional
GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction. string

# ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

# Error

Error response returned when the request is unsuccessful.

Name Description Schema
code
required
An error code that identifies the type of error that occurred. string
message
required
A message that describes the error condition. string
details
optional
Additional details that can help the caller understand or fix the issue. string
Last Updated: 10/11/2022, 9:45:34 PM