Selling Partner API for External Fulfillment Inventory Management (2021-01-06,2024-09-11)

Download OpenAPI specification:Download

Selling Partner API Test Support: smartconnect-support@amazon.com URL: https://github.com/amzn/amazon-marketplace-api-sdk/issues License: Amazon Software License

This section provides APIs for selling partners to work with External Fulfillment inventory services.

updateInventory

Update the inventory quantity of the given SKU in the specified location to the provided value across all channel where listing exists.

path Parameters

locationId required	string The node identifier for the seller's location in smart connect for which inventory is being updated
skuId required	string The listing identifier for which inventory is being updated

query Parameters

quantity

required

integer <int32> >= 0

The absolute number of items of the specified SKU available at the specified node. This value should always be a non-zero or zero positive integer

header Parameters

If-Match	string A unique number provided with each call to update the inventory. This number must be latest version of entity that exist in system. It will be equal to comparison against existing version of entity.
If-Unmodified-Since	string Timestamp or increasing number which does greater than comparison before applying the change. This is different than version of entity and used to overwrite the latest data. It should follow data/time format of rfc2616, e.g: Sun, 06 Nov 1994 08:49:37 GMT

Responses

Response samples

Content type

application/json

{"sellableQuantity": 15,
"reservedQuantity": 0,
"marketplaceChannelInventories": [{"sellableQuantity": 13,
"bufferedQuantity": 2,
"marketplaceAttributes": {"marketplaceName": "AMAZON_IN",
"channelName": "MFN"
}
},
{"sellableQuantity": 0,
"bufferedQuantity": 0,
"marketplaceAttributes": {"marketplaceName": "AMAZON_IN",
"channelName": "FBA"
},
"sellerActionableErrors": [{"errorType": "PRODUCT_ATTRIBUTE_VALIDATION_FAILURE",
"errorSubtype": "MISSING_WEIGHT",
"errorDescription": "Product is missing required attributes",
"errorSubtypeDescription": "No product weight entered for SKU"
},
{"errorType": "PRODUCT_ATTRIBUTE_VALIDATION_FAILURE",
"errorSubtype": "MISSING_DIMENSIONS",
"errorDescription": "Product is missing required attributes",
"errorSubtypeDescription": "No product dimensions entered for SKU"
}
]
}
]
}

getInventory

Get the current inventory for a given SKU at a given location.

path Parameters

locationId required	string The node identifier for the seller's location in smart connect for which inventory is being updated
skuId required	string The seller's identifier for the SKU for which inventory is being updated

Responses

Response samples

Content type

application/json

{"sellableQuantity": 15,
"reservedQuantity": 0,
"marketplaceChannelInventories": [{"sellableQuantity": 13,
"bufferedQuantity": 2,
"marketplaceAttributes": {"marketplaceName": "AMAZON_IN",
"channelName": "FBA"
}
}
]
}

batchInventory

Returns the set of responses that correspond to the batched list of up to 10 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the inventory count for provided sku and locationId pair

Request Body schema: application/json

The batch of batchInventoryRequest. Using the same API user can perform update inventory operation as well as get inventory operation.

Array of objects (BatchInventoryRequestList) [ 1 .. 10 ] items

A batched list of Batch Inventory requests.

Responses

Request samples

Payload

Content type

application/json

{"requests": [{"method": "POST",
"uri": "/inventory/update?locationId=EXSB&skuId=efptestsku1",
"body": {"quantity": 15,
"clientSequenceNumber": 12345678,
"marketplaceAttributes": {"marketplaceId": "AXJDDKDFDKDF",
"channelName": "FBA"
}
}
},
{"method": "POST",
"uri": "/inventory/fetch?locationId=EXSB&skuId=efptestsku2",
"body": {"marketplaceAttributes": {"marketplaceId": "AXJDDKDFDKDF",
"channelName": "FBA"
}
}
}
]
}

Response samples

Content type

application/json

{"responses": [{"status": {"statusCode": 200,
"reasonPhrase": "Success"
},
"body": {"locationId": "EXSB",
"sellableQuantity": 20,
"reservedQuantity": 5,
"clientSequenceNumber": 12345678,
"marketplaceAttributes": {"marketplaceId": "AXJDDKDFDKDF",
"channelName": "FBA"
},
"skuId": "efptestsku1",
"actionableErrors": [ ]
}
},
{"status": {"statusCode": 400,
"reasonPhrase": "Invalid Input"
},
"body": {"skuId": "efptestsku2",
"locationId": "EXSB",
"actionableErrors": [{"errorType": "INVALID_SKU",
"errorSubType": "The requested Sku does not exist for the seller in requested marketplace."
}
]
}
}
]
}