Update Listings Items 2021 model
This commit is contained in:
Jack Evoniuk
parent
9e01aa266d
commit
b586f61953
|
|
@ -318,7 +318,7 @@
|
|||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-example": "summaries",
|
||||
"default": "summaries"
|
||||
"default": ["summaries"]
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
|
|
@ -708,7 +708,7 @@
|
|||
"tags": [
|
||||
"listings"
|
||||
],
|
||||
"description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "patchListingsItem",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
|
|
@ -743,6 +743,50 @@
|
|||
"collectionFormat": "csv",
|
||||
"x-example": "ATVPDKIKX0DER"
|
||||
},
|
||||
{
|
||||
"name": "includedData",
|
||||
"description": "A comma-delimited list of data sets to include in the response. Default: `issues`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"enum": [
|
||||
"identifiers",
|
||||
"issues"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "identifiers",
|
||||
"description": "Identifiers associated with the item in the Amazon catalog, such as Amazon Standard Identification Number (ASIN). Can only be requested when `mode` is `VALIDATION_PREVIEW`."
|
||||
},
|
||||
{
|
||||
"value": "issues",
|
||||
"description": "The issues associated with the listing item."
|
||||
}
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-example": "issues",
|
||||
"default": ["issues"]
|
||||
},
|
||||
{
|
||||
"name": "mode",
|
||||
"description": "The mode of operation for the request.",
|
||||
"in": "query",
|
||||
"enum": [
|
||||
"VALIDATION_PREVIEW"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "VALIDATION_PREVIEW",
|
||||
"description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog."
|
||||
}
|
||||
],
|
||||
"required": false,
|
||||
"type": "string",
|
||||
"x-example": "VALIDATION_PREVIEW"
|
||||
},
|
||||
{
|
||||
"name": "issueLocale",
|
||||
"description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale.",
|
||||
|
|
@ -800,6 +844,91 @@
|
|||
"submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003",
|
||||
"issues": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"sku": {
|
||||
"value": "VALIDATION_VALID"
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"value": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"includedData": {
|
||||
"value": [
|
||||
"identifiers",
|
||||
"issues"
|
||||
]
|
||||
},
|
||||
"mode": {
|
||||
"value": "VALIDATION_PREVIEW"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"sku": "VALIDATION_VALID",
|
||||
"status": "VALID",
|
||||
"submissionId": "1edc94ea-a3d7-210b-42bc-0ec72c1384762",
|
||||
"identifiers": [
|
||||
{
|
||||
"marketplaceId": "ATVPDKIKX0DER",
|
||||
"asin": "B07N4M94X4"
|
||||
}
|
||||
],
|
||||
"issues": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"sku": {
|
||||
"value": "VALIDATION_INVALID"
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"value": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"includedData": {
|
||||
"value": [
|
||||
"identifiers",
|
||||
"issues"
|
||||
]
|
||||
},
|
||||
"mode": {
|
||||
"value": "VALIDATION_PREVIEW"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"sku": "VALIDATION_INVALID",
|
||||
"status": "INVALID",
|
||||
"submissionId": "a1c562c2-1695-11ee-be56-0242ac120002",
|
||||
"identifiers": [],
|
||||
"issues": [
|
||||
{
|
||||
"code":"90000900",
|
||||
"message":"The attributes are invalid.",
|
||||
"severity":"ERROR",
|
||||
"attributeNames": [
|
||||
"fake_attribute"
|
||||
],
|
||||
"categories": ["INVALID_ATTRIBUTE"],
|
||||
"enforcements": {
|
||||
"actions": [
|
||||
{
|
||||
"action": "ATTRIBUTE_SUPPRESSED"
|
||||
}
|
||||
],
|
||||
"exemption": {
|
||||
"status": "NOT_EXEMPT"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -920,7 +1049,7 @@
|
|||
"tags": [
|
||||
"listings"
|
||||
],
|
||||
"description": "Creates or fully updates an existing listings item for a selling partner.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "Creates or fully updates an existing listings item for a selling partner.\n\n**Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "putListingsItem",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
|
|
@ -955,6 +1084,50 @@
|
|||
"collectionFormat": "csv",
|
||||
"x-example": "ATVPDKIKX0DER"
|
||||
},
|
||||
{
|
||||
"name": "includedData",
|
||||
"description": "A comma-delimited list of data sets to include in the response. Default: `issues`.",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"enum": [
|
||||
"identifiers",
|
||||
"issues"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "identifiers",
|
||||
"description": "Identifiers associated with the item in the Amazon catalog, such as Amazon Standard Identification Number (ASIN). Can only be requested when `mode` is `VALIDATION_PREVIEW`."
|
||||
},
|
||||
{
|
||||
"value": "issues",
|
||||
"description": "The issues associated with the listing item."
|
||||
}
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "csv",
|
||||
"x-example": "issues",
|
||||
"default": ["issues"]
|
||||
},
|
||||
{
|
||||
"name": "mode",
|
||||
"description": "The mode of operation for the request.",
|
||||
"in": "query",
|
||||
"enum": [
|
||||
"VALIDATION_PREVIEW"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "VALIDATION_PREVIEW",
|
||||
"description": "Indicates the submitted data should be validated without persisting to the selling partner's catalog."
|
||||
}
|
||||
],
|
||||
"required": false,
|
||||
"type": "string",
|
||||
"x-example": "VALIDATION_PREVIEW"
|
||||
},
|
||||
{
|
||||
"name": "issueLocale",
|
||||
"description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale.",
|
||||
|
|
@ -1012,6 +1185,100 @@
|
|||
"submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003",
|
||||
"issues": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"sku": {
|
||||
"value": "VALIDATION_VALID"
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"value": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"includedData": {
|
||||
"value": [
|
||||
"identifiers",
|
||||
"issues"
|
||||
]
|
||||
},
|
||||
"mode": {
|
||||
"value": "VALIDATION_PREVIEW"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"sku": "VALIDATION_VALID",
|
||||
"status": "VALID",
|
||||
"submissionId": "1edc94ea-a3d7-210b-42bc-0ec72c1384762",
|
||||
"identifiers": [
|
||||
{
|
||||
"marketplaceId": "ATVPDKIKX0DER",
|
||||
"asin": "B07N4M94X4"
|
||||
}
|
||||
],
|
||||
"issues": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"sku": {
|
||||
"value": "VALIDATION_INVALID"
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"value": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"includedData": {
|
||||
"value": [
|
||||
"identifiers",
|
||||
"issues"
|
||||
]
|
||||
},
|
||||
"mode": {
|
||||
"value": "VALIDATION_PREVIEW"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"sku": "VALIDATION_INVALID",
|
||||
"status": "INVALID",
|
||||
"submissionId": "a1c562c2-1695-11ee-be56-0242ac120002",
|
||||
"identifiers": [],
|
||||
"issues": [
|
||||
{
|
||||
"code":"90220",
|
||||
"message":"'condition_type' is required but not supplied.",
|
||||
"severity":"ERROR",
|
||||
"attributeNames": [
|
||||
"condition_type"
|
||||
],
|
||||
"categories": ["MISSING_ATTRIBUTE"],
|
||||
"enforcements": {
|
||||
"actions": [
|
||||
{
|
||||
"action": "LISTING_SUPPRESSED"
|
||||
}
|
||||
],
|
||||
"exemption": {
|
||||
"status": "NOT_EXEMPT"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"code":"90000900",
|
||||
"message":"The attributes are invalid.",
|
||||
"severity":"ERROR",
|
||||
"attributeNames": [
|
||||
"fake_attribute"
|
||||
],
|
||||
"categories": []
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -1759,7 +2026,8 @@
|
|||
"description": "The status of the listings item submission.",
|
||||
"enum": [
|
||||
"ACCEPTED",
|
||||
"INVALID"
|
||||
"INVALID",
|
||||
"VALID"
|
||||
],
|
||||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
|
|
@ -1769,6 +2037,10 @@
|
|||
{
|
||||
"value": "INVALID",
|
||||
"description": "The listings submission was not valid and was not accepted for processing."
|
||||
},
|
||||
{
|
||||
"value": "VALID",
|
||||
"description": "The listings submission was valid. Only returned when the `mode` is `VALIDATION_PREVIEW`."
|
||||
}
|
||||
],
|
||||
"type": "string"
|
||||
|
|
@ -1783,6 +2055,10 @@
|
|||
"items": {
|
||||
"$ref": "#/definitions/Issue"
|
||||
}
|
||||
},
|
||||
"identifiers": {
|
||||
"description": "Identity attributes associated with the item in the Amazon catalog, such as the ASIN.",
|
||||
"$ref": "#/definitions/ItemIdentifiers"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -1791,6 +2067,27 @@
|
|||
"submissionId"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"ItemIdentifiers": {
|
||||
"description": "Identity attributes associated with the item in the Amazon catalog, such as the ASIN.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ItemIdentifiersByMarketplace"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"ItemIdentifiersByMarketplace": {
|
||||
"description": "Identity attributes associated with the item in the Amazon catalog for the indicated Amazon marketplace.",
|
||||
"properties": {
|
||||
"marketplaceId": {
|
||||
"description": "A marketplace identifier. Identifies the Amazon marketplace for the listings item.",
|
||||
"type": "string"
|
||||
},
|
||||
"asin": {
|
||||
"description": "Amazon Standard Identification Number (ASIN) of the listings item.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue