452 lines
24 KiB
JSON
452 lines
24 KiB
JSON
|
{
|
||
|
|
"swagger": "2.0",
|
||
|
|
"info": {
|
||
|
|
"description": "With the FBA Inbound Eligibility API, you can build applications that let sellers get eligibility previews for items before shipping them to Amazon's fulfillment centers. With this API you can find out if an item is eligible for inbound shipment to Amazon's fulfillment centers in a specific marketplace. You can also find out if an item is eligible for using the manufacturer barcode for FBA inventory tracking. Sellers can use this information to inform their decisions about which items to ship Amazon's fulfillment centers.",
|
||
|
|
"version": "v1",
|
||
|
|
"title": "Amazon Selling Partner API for FBA Inbound Eligibilty",
|
||
|
|
"contact": {
|
||
|
|
"name": "Amazon Selling Partner API Test Support",
|
||
|
|
"url": "https://github.com/amzn/amazon-marketplace-api-sdk/issues",
|
||
|
|
"email": "marketplaceapitest@amazon.com"
|
||
|
|
},
|
||
|
|
"license": {
|
||
|
|
"name": "Amazon Software License",
|
||
|
|
"url": "https://aws.amazon.com/asl/"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"host": "sellingpartnerapi-na.amazon.com",
|
||
|
|
"schemes": [
|
||
|
|
"https"
|
||
|
|
],
|
||
|
|
"consumes": [
|
||
|
|
"application/json"
|
||
|
|
],
|
||
|
|
"produces": [
|
||
|
|
"application/json"
|
||
|
|
],
|
||
|
|
"paths": {
|
||
|
|
"/fba/inbound/v1/eligibility/itemPreview": {
|
||
|
|
"get": {
|
||
|
|
"tags": [
|
||
|
|
"fbaInbound"
|
||
|
|
],
|
||
|
|
"description": "This operation gets an eligibility preview for an item that you specify. You can specify the type of eligibility preview that you want (INBOUND or COMMINGLING). For INBOUND previews, you can specify the marketplace in which you want to determine the item's eligibility.",
|
||
|
|
"operationId": "getItemEligibilityPreview",
|
||
|
|
"parameters": [
|
||
|
|
{
|
||
|
|
"name": "marketplaceIds",
|
||
|
|
"in": "query",
|
||
|
|
"description": "The identifier for the marketplace in which you want to determine eligibility. Required only when program=INBOUND.",
|
||
|
|
"required": false,
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"maxItems": 1
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "asin",
|
||
|
|
"in": "query",
|
||
|
|
"description": "The ASIN of the item for which you want an eligibility preview.",
|
||
|
|
"required": true,
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "program",
|
||
|
|
"in": "query",
|
||
|
|
"description": "The program that you want to check eligibility against.",
|
||
|
|
"required": true,
|
||
|
|
"type": "string",
|
||
|
|
"enum": [
|
||
|
|
"INBOUND",
|
||
|
|
"COMMINGLING"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"responses": {
|
||
|
|
"200": {
|
||
|
|
"description": "Success.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"examples": {
|
||
|
|
"ItemEligibilityPreview": {
|
||
|
|
"payload": {
|
||
|
|
"asin": "TEST_ASIN",
|
||
|
|
"marketplaceId": "TEST_MARKETPLACE_ID",
|
||
|
|
"program": "INBOUND",
|
||
|
|
"isEligibleForProgram": true
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_200"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"payload": {
|
||
|
|
"asin": "TEST_CASE_200",
|
||
|
|
"marketplaceId": "TEST_CASE_200",
|
||
|
|
"program": "INBOUND",
|
||
|
|
"isEligibleForProgram": true
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"400": {
|
||
|
|
"description": "Request has missing or invalid parameters and cannot be parsed.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_400"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "InvalidInput",
|
||
|
|
"message": "Invalid input."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"401": {
|
||
|
|
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_401"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "Unauthorized",
|
||
|
|
"message": "Access to requested resource is denied."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"403": {
|
||
|
|
"description": "403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_403"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "Unauthorized",
|
||
|
|
"message": "Access to requested resource is denied."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"404": {
|
||
|
|
"description": "The resource specified does not exist.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_404"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "NotFound",
|
||
|
|
"message": "The requested resource doesn't exist."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"429": {
|
||
|
|
"description": "The frequency of requests was greater than allowed.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_429"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "QuotaExceeded",
|
||
|
|
"message": "You exceeded your quota for the requested resource."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"500": {
|
||
|
|
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_500"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "InternalFailure",
|
||
|
|
"message": "We encountered an internal error. Please try again."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"503": {
|
||
|
|
"description": "Temporary overloading or maintenance of the server.",
|
||
|
|
"schema": {
|
||
|
|
"$ref": "#/definitions/GetItemEligibilityPreviewResponse"
|
||
|
|
},
|
||
|
|
"headers": {
|
||
|
|
"x-amzn-RequestId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Unique request reference ID."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"x-amazon-spds-sandbox-behaviors": [
|
||
|
|
{
|
||
|
|
"request": {
|
||
|
|
"parameters": {
|
||
|
|
"asin": {
|
||
|
|
"value": "TEST_CASE_503"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"response": {
|
||
|
|
"errors": [
|
||
|
|
{
|
||
|
|
"code": "ServiceUnavailable",
|
||
|
|
"message": "Service is temporarily unavailable. Please try again."
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"parameters": []
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"definitions": {
|
||
|
|
"GetItemEligibilityPreviewResponse": {
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"payload": {
|
||
|
|
"description": "The payload for the getItemEligibilityPreview operation.",
|
||
|
|
"$ref": "#/definitions/ItemEligibilityPreview"
|
||
|
|
},
|
||
|
|
"errors": {
|
||
|
|
"description": "An unexpected condition occurred during the GetItemEligibilityPreview operation.",
|
||
|
|
"$ref": "#/definitions/ErrorList"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"description": "The response schema for the getItemEligibilityPreview operation."
|
||
|
|
},
|
||
|
|
"ItemEligibilityPreview": {
|
||
|
|
"type": "object",
|
||
|
|
"required": [
|
||
|
|
"asin",
|
||
|
|
"isEligibleForProgram",
|
||
|
|
"program"
|
||
|
|
],
|
||
|
|
"properties": {
|
||
|
|
"asin": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "The ASIN for which eligibility was determined."
|
||
|
|
},
|
||
|
|
"marketplaceId": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "The marketplace for which eligibility was determined."
|
||
|
|
},
|
||
|
|
"program": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "The program for which eligibility was determined. Values:\n * INBOUND - Inbound shipment.\n * COMMINGLING - Using the manufacturer barcode for FBA inventory tracking.",
|
||
|
|
"enum": [
|
||
|
|
"INBOUND",
|
||
|
|
"COMMINGLING"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"isEligibleForProgram": {
|
||
|
|
"type": "boolean",
|
||
|
|
"description": "Indicates if the item is eligible for the program."
|
||
|
|
},
|
||
|
|
"ineligibilityReasonList": {
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Potential Ineligibility Reason Codes: \n- FBA_INB_0004: Missing package dimensions. This product is missing necessary information; dimensions need to be provided in the manufacturer's original packaging.\n- FBA_INB_0006: The SKU for this product is unknown or cannot be found.\n- FBA_INB_0007: Product Under Dangerous Goods (Hazmat) Review. We do not have enough information to determine what the product is or comes with to enable us to complete our dangerous goods review. Until you provide the necessary information, the products will not be available for sale and you will not be able to send more units to Amazon fulfillment centers. You will need to add more details to the product listings, such as a clear title, bullet points, description, and image. The review process takes 4 business days.\n- FBA_INB_0008: Product Under Dangerous Goods (Hazmat) Review. We require detailed battery information to correctly classify the product, and until you provide the necessary information, the products will not be available for sale and you will not be able to send more units to Amazon fulfillment centers. Download an exemption sheet for battery and battery-powered products available in multiple languages in \"Upload dangerous goods documents: safety data sheet (SDS) or exemption sheet\" in Seller Central and follow instructions to submit it through the same page. The review process takes 4 business days.\n- FBA_INB_0009: Product Under Dangerous Goods (Hazmat) Review. We do not have enough dangerous goods information to correctly classify the product and until you provide the necessary information, the products will not be available for sale and you will not be able to send more units to Amazon fulfillment centers. Please provide a Safety Data Sheet (SDS) through \"Upload dangerous goods documents: safety data sheet (SDS) or exemption sheet\" in Seller Central, and make sure the SDS complies with all the requirements. The review process takes 4 business days.\n- FBA_INB_0010: Product Under Dangerous Goods (Hazmat) Review. The dangerous goods information is mismatched and so the product cannot be correctly classified. Until you provide the necessary information, the products will not be available for sale and you will not be able to send more units to Amazon fulfillment centers. Please provide compliant documents through \"Upload dangerous goods documents: safety data sheet (SDS) or exemption sheet\" in Seller Central, and make sure it complies with all the requirements. The review process takes 4 business days, the product will remain unfulfillable until review process is complete.\n- FBA_INB_0011: Product Under Dangerous Goods (Hazmat) Review. We have incomplete, inaccurate or conflicting dangerous goods information and cannot correctly classify the product. Until you provide the necessary information, the products will not be available for sale and you will not be able to send more units to Amazon fulfillment centers. Please provide compliant documents through \"Upload dangerous goods documents: safety data sheet (SDS) or exemption sheet\" in Seller Central, and make sure it complies with all the requirements. The review process takes 4 business days and the product will remain unfulfillable until the review process is complete.\n- FBA_INB_0012: Product Under Dangerous Goods (Hazmat) Review. We have determined there is conflicting product information (title, bullet points, images, or product description) within the product detail pages or with other offers for the product. Until the conflicting information is corrected, the products will not be available for sale and you will not be able to send more units to Amazon fulfillment centers. We need you to confirm the information on the product detail page The review process takes 4 business days.\n- FBA_INB_0013: Product Under Dangerous Goods (Hazmat) Review. Additional information is required in order to complete the Hazmat review process.\n- FBA_INB_0014: Product Under Dangerous Goods (Hazmat) Review. The product has been identified as possible dangerous go
|
||
|
|
"enum": [
|
||
|
|
"FBA_INB_0004",
|
||
|
|
"FBA_INB_0006",
|
||
|
|
"FBA_INB_0007",
|
||
|
|
"FBA_INB_0008",
|
||
|
|
"FBA_INB_0009",
|
||
|
|
"FBA_INB_0010",
|
||
|
|
"FBA_INB_0011",
|
||
|
|
"FBA_INB_0012",
|
||
|
|
"FBA_INB_0013",
|
||
|
|
"FBA_INB_0014",
|
||
|
|
"FBA_INB_0015",
|
||
|
|
"FBA_INB_0016",
|
||
|
|
"FBA_INB_0017",
|
||
|
|
"FBA_INB_0018",
|
||
|
|
"FBA_INB_0019",
|
||
|
|
"FBA_INB_0034",
|
||
|
|
"FBA_INB_0035",
|
||
|
|
"FBA_INB_0036",
|
||
|
|
"FBA_INB_0037",
|
||
|
|
"FBA_INB_0038",
|
||
|
|
"FBA_INB_0050",
|
||
|
|
"FBA_INB_0051",
|
||
|
|
"FBA_INB_0053",
|
||
|
|
"FBA_INB_0055",
|
||
|
|
"FBA_INB_0056",
|
||
|
|
"FBA_INB_0059",
|
||
|
|
"FBA_INB_0065",
|
||
|
|
"FBA_INB_0066",
|
||
|
|
"FBA_INB_0067",
|
||
|
|
"FBA_INB_0068",
|
||
|
|
"FBA_INB_0095",
|
||
|
|
"FBA_INB_0097",
|
||
|
|
"FBA_INB_0098",
|
||
|
|
"FBA_INB_0099",
|
||
|
|
"FBA_INB_0100",
|
||
|
|
"FBA_INB_0103",
|
||
|
|
"FBA_INB_0104",
|
||
|
|
"UNKNOWN_INB_ERROR_CODE"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"description": "The response object which contains the ASIN, marketplaceId if required, eligibility program, the eligibility status (boolean), and a list of ineligibility reason codes."
|
||
|
|
},
|
||
|
|
"ErrorList": {
|
||
|
|
"type": "array",
|
||
|
|
"description": "A list of error responses returned when a request is unsuccessful.",
|
||
|
|
"items": {
|
||
|
|
"$ref": "#/definitions/Error"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Error": {
|
||
|
|
"type": "object",
|
||
|
|
"required": [
|
||
|
|
"code"
|
||
|
|
],
|
||
|
|
"properties": {
|
||
|
|
"code": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "An error code that identifies the type of error that occurred."
|
||
|
|
},
|
||
|
|
"message": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "A message that describes the error condition in a human-readable form."
|
||
|
|
},
|
||
|
|
"details": {
|
||
|
|
"type": "string",
|
||
|
|
"description": "Additional information that can help the caller understand or fix the issue."
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"description": "Error response returned when the request is unsuccessful."
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|