Merge branch 'main' of https://github.com/amzn/selling-partner-api-models
This commit is contained in:
Sal Ricciardi
commit
f50e67b7ff
|
|
@ -29,7 +29,7 @@
|
|||
"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.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"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.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "getItemEligibilityPreview",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "getEligibleShipmentServicesOld",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -83,13 +83,13 @@
|
|||
"Phone": "7132341234"
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10,
|
||||
"Width": 10,
|
||||
"Height": 10,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingServiceOptions": {
|
||||
|
|
@ -106,8 +106,8 @@
|
|||
"payload": {
|
||||
"ShippingServiceList": [
|
||||
{
|
||||
"ShippingServiceName": "UPS 2nd Day Air",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKoZAReW8oJ1SMumuBS8lA/Hjuglhyiu0+KRLvyJxFV0PB9YFMDhygs3VyTL0WGYkGxiuRkmuEvpqldUn9rrkWVodqnR4vx2VtXvtER/Ju6RqYoddJZGy6RS2KLzzhQ2NclN0NYXMZVqpOe5RsRBddXaGuJr7oza3M52+JzChocAHzcurIhCRynpbxfmNLzZMQEbgnpGLzuaoSMzfxg90/NaXFR/Ou01du/uKd5AbfMW/AxAKP9ht6Oi9lDHq6WkGqvjkVLW0/jj/fBgblIwcs+t",
|
||||
"ShipDate": "2019-10-28T16:36:36Z",
|
||||
|
|
@ -144,8 +144,8 @@
|
|||
]
|
||||
},
|
||||
{
|
||||
"ShippingServiceName": "UPS Next Day Air Saver",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS Next Day Air Saver\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_NEXT_DAY_AIR_SAVER",
|
||||
"ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKqqhKGQ2YZmuxsXKVXmdgdWNvfxb1qfm5bGm8NuqlqnNT3eTiJ4viTctepggbeUKUSykClJ+Qmw43zdA8wsgREhQCmb4Bbo/skapLQS1F9uwH2FgY5SfMsj/egudyocpVRT45KSQAT0H5YiXW3OyyRAae9fZ0RzDJAABHiisOyYyXnB1mtWOZqc7rlGR4yyqN7jmiT4t8dmuGPX7ptY4qskrN+6VHZO9bM9tdDS0ysHhAVv4jO3Q5sWFg4nEPaARWSsrpa6zSGMLxAOj56O3tcP",
|
||||
"ShipDate": "2019-10-28T16:36:36Z",
|
||||
|
|
@ -184,7 +184,7 @@
|
|||
],
|
||||
"TemporarilyUnavailableCarrierList": [
|
||||
{
|
||||
"CarrierName": "UPS"
|
||||
"CarrierName": "UPS\u00AE"
|
||||
},
|
||||
{
|
||||
"CarrierName": "DHLECOMMERCE"
|
||||
|
|
@ -245,13 +245,13 @@
|
|||
"Phone": "7132341234"
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10,
|
||||
"Width": 10,
|
||||
"Height": 10,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingServiceOptions": {
|
||||
|
|
@ -377,7 +377,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 10 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Returns a list of shipping service offers that satisfy the specified shipment request details.\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": "getEligibleShipmentServices",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -431,13 +431,13 @@
|
|||
"Phone": "7132341234"
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10,
|
||||
"Width": 10,
|
||||
"Height": 10,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingServiceOptions": {
|
||||
|
|
@ -454,8 +454,8 @@
|
|||
"payload": {
|
||||
"ShippingServiceList": [
|
||||
{
|
||||
"ShippingServiceName": "UPS 2nd Day Air",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKoZAReW8oJ1SMumuBS8lA/Hjuglhyiu0+KRLvyJxFV0PB9YFMDhygs3VyTL0WGYkGxiuRkmuEvpqldUn9rrkWVodqnR4vx2VtXvtER/Ju6RqYoddJZGy6RS2KLzzhQ2NclN0NYXMZVqpOe5RsRBddXaGuJr7oza3M52+JzChocAHzcurIhCRynpbxfmNLzZMQEbgnpGLzuaoSMzfxg90/NaXFR/Ou01du/uKd5AbfMW/AxAKP9ht6Oi9lDHq6WkGqvjkVLW0/jj/fBgblIwcs+t",
|
||||
"ShipDate": "2019-10-28T16:36:36Z",
|
||||
|
|
@ -492,8 +492,8 @@
|
|||
]
|
||||
},
|
||||
{
|
||||
"ShippingServiceName": "UPS Next Day Air Saver",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS Next Day Air Saver\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_NEXT_DAY_AIR_SAVER",
|
||||
"ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKqqhKGQ2YZmuxsXKVXmdgdWNvfxb1qfm5bGm8NuqlqnNT3eTiJ4viTctepggbeUKUSykClJ+Qmw43zdA8wsgREhQCmb4Bbo/skapLQS1F9uwH2FgY5SfMsj/egudyocpVRT45KSQAT0H5YiXW3OyyRAae9fZ0RzDJAABHiisOyYyXnB1mtWOZqc7rlGR4yyqN7jmiT4t8dmuGPX7ptY4qskrN+6VHZO9bM9tdDS0ysHhAVv4jO3Q5sWFg4nEPaARWSsrpa6zSGMLxAOj56O3tcP",
|
||||
"ShipDate": "2019-10-28T16:36:36Z",
|
||||
|
|
@ -532,7 +532,7 @@
|
|||
],
|
||||
"TemporarilyUnavailableCarrierList": [
|
||||
{
|
||||
"CarrierName": "UPS"
|
||||
"CarrierName": "UPS\u00AE"
|
||||
},
|
||||
{
|
||||
"CarrierName": "DHLECOMMERCE"
|
||||
|
|
@ -593,13 +593,13 @@
|
|||
"Phone": "7132341234"
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10,
|
||||
"Width": 10,
|
||||
"Height": 10,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingServiceOptions": {
|
||||
|
|
@ -725,7 +725,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Returns the shipment information for an existing shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Returns the shipment information for an existing shipment.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "getShipment",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -800,18 +800,18 @@
|
|||
"Phone": ""
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10.0,
|
||||
"Width": 10.0,
|
||||
"Height": 10.0,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "",
|
||||
"ShipDate": "2019-10-28T18:00:00Z",
|
||||
|
|
@ -986,7 +986,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Cancel the shipment indicated by the specified shipment identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Cancel the shipment indicated by the specified shipment identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "cancelShipment",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1061,18 +1061,18 @@
|
|||
"Phone": ""
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10.0,
|
||||
"Width": 10.0,
|
||||
"Height": 10.0,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "",
|
||||
"ShipDate": "2019-10-28T18:00:00Z",
|
||||
|
|
@ -1245,7 +1245,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Cancel the shipment indicated by the specified shipment identifer.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Cancel the shipment indicated by the specified shipment identifer.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "cancelShipmentOld",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1320,18 +1320,18 @@
|
|||
"Phone": ""
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10.0,
|
||||
"Width": 10.0,
|
||||
"Height": 10.0,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS 2nd Day Air \u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "",
|
||||
"ShipDate": "2019-10-28T18:00:00Z",
|
||||
|
|
@ -1504,7 +1504,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Create a shipment with the information provided.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Create a shipment with the information provided.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "createShipment",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1558,13 +1558,13 @@
|
|||
"Phone": "7132341234"
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10,
|
||||
"Width": 10,
|
||||
"Height": 10,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingServiceOptions": {
|
||||
|
|
@ -1615,18 +1615,18 @@
|
|||
"Phone": ""
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"Length": 10,
|
||||
"Width": 10,
|
||||
"Height": 10,
|
||||
"Length": 10.25,
|
||||
"Width": 10.25,
|
||||
"Height": 10.25,
|
||||
"Unit": "inches"
|
||||
},
|
||||
"Weight": {
|
||||
"Value": 10,
|
||||
"Value": 10.25,
|
||||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air",
|
||||
"CarrierName": "UPS",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "WHgxtyn6qjGGaCzOCog1azF5HLHje5Pz3Lc2Fmt5eKoZAReW8oJ1SMumuBS8lA/Hjuglhyiu0+KRLvyJxFV0PB9YFMDhygs3VyTL0WGYkGxiuRkmuEvpqldUn9rrkWVodqnR4vx2VtXvtER/Ju6RqYoddJZGy6RS2KLzzhQ2NclN0NYXMZVqpOe5RsRBddXaGuJr7oza3M52+JzChocAHzcurIhCRynpbxfmNLzZMQEbgnpGLzuaoSMzfxg90/NaXFR/Ou01du/uKd5AbfMW/AxAKP9ht6Oi9lDHq6WkGqvjkVLW0/jj/fBgblIwcs+t",
|
||||
"ShipDate": "2019-10-28T16:37:37Z",
|
||||
|
|
@ -1842,7 +1842,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Get a list of additional seller inputs required for a ship method. This is generally used for international shipping.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Get a list of additional seller inputs required for a ship method. This is generally used for international shipping.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "getAdditionalSellerInputsOld",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -2063,7 +2063,7 @@
|
|||
"tags": [
|
||||
"merchantFulfillment"
|
||||
],
|
||||
"description": "Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Gets a list of additional seller inputs required for a ship method. This is generally used for international shipping.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 1 |\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": "getAdditionalSellerInputs",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
"tags": [
|
||||
"solicitations"
|
||||
],
|
||||
"description": "Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Returns a list of solicitation types that are available for an order that you specify. A solicitation type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a solicitation. Currently only the productReviewAndSellerFeedbackSolicitation solicitation type is available.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\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": "getSolicitationActionsForOrder",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -106,23 +106,23 @@
|
|||
"value": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"_links": {
|
||||
"actions": [
|
||||
{
|
||||
"href": "/solicitations/v1/orders/123-1234567-1234567/solicitations/productReviewAndSellerFeedback?marketplaceIds=ATVPDKIKX0DER",
|
||||
"name": "productReviewAndSellerFeedback"
|
||||
}
|
||||
],
|
||||
"self": {
|
||||
"href": "/solicitations/v1/orders/123-1234567-1234567?marketplaceIds=ATVPDKIKX0DER"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"_links": {
|
||||
"actions": [
|
||||
{
|
||||
"href": "/solicitations/v1/orders/123-1234567-1234567/solicitations/productReviewAndSellerFeedback?marketplaceIds=ATVPDKIKX0DER",
|
||||
"name": "productReviewAndSellerFeedback"
|
||||
}
|
||||
],
|
||||
"self": {
|
||||
"href": "/solicitations/v1/orders/123-1234567-1234567?marketplaceIds=ATVPDKIKX0DER"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
|
|
@ -258,7 +258,7 @@
|
|||
"tags": [
|
||||
"solicitations"
|
||||
],
|
||||
"description": "Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\n\nFor more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.",
|
||||
"description": "Sends a solicitation to a buyer asking for seller feedback and a product review for the specified order. Send only one productReviewAndSellerFeedback or free form proactive message per order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 1 | 5 |\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": "createProductReviewAndSellerFeedbackSolicitation",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
"tags": [
|
||||
"updateInventory"
|
||||
],
|
||||
"description": "Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 10 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe 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.",
|
||||
"description": "Submits inventory updates for the specified warehouse for either a partial or full feed of inventory items.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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": "submitInventoryUpdate",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -76,58 +76,58 @@
|
|||
"partyId": "VENDORID"
|
||||
},
|
||||
"isFullUpdate": false,
|
||||
"items": [
|
||||
{
|
||||
"buyerProductIdentifier": "ABCD4562",
|
||||
"vendorProductIdentifier": "7Q89K11",
|
||||
"availableQuantity": {
|
||||
"amount": 10,
|
||||
"unitOfMeasure": "Each"
|
||||
"items": [
|
||||
{
|
||||
"buyerProductIdentifier": "ABCD4562",
|
||||
"vendorProductIdentifier": "7Q89K11",
|
||||
"availableQuantity": {
|
||||
"amount": 10,
|
||||
"unitOfMeasure": "Each"
|
||||
},
|
||||
"isObsolete": false
|
||||
},
|
||||
"isObsolete": false
|
||||
},
|
||||
{
|
||||
"buyerProductIdentifier": "ABCD4563",
|
||||
"vendorProductIdentifier": "7Q89K12",
|
||||
"availableQuantity": {
|
||||
"amount": 15,
|
||||
"unitOfMeasure": "Each"
|
||||
{
|
||||
"buyerProductIdentifier": "ABCD4563",
|
||||
"vendorProductIdentifier": "7Q89K12",
|
||||
"availableQuantity": {
|
||||
"amount": 15,
|
||||
"unitOfMeasure": "Each"
|
||||
},
|
||||
"isObsolete": false
|
||||
},
|
||||
"isObsolete": false
|
||||
},
|
||||
{
|
||||
"buyerProductIdentifier": "ABCD4564",
|
||||
"vendorProductIdentifier": "7Q89K13",
|
||||
"availableQuantity": {
|
||||
"amount": 20,
|
||||
"unitOfMeasure": "Each"
|
||||
},
|
||||
"isObsolete": false
|
||||
}
|
||||
]
|
||||
{
|
||||
"buyerProductIdentifier": "ABCD4564",
|
||||
"vendorProductIdentifier": "7Q89K13",
|
||||
"availableQuantity": {
|
||||
"amount": 20,
|
||||
"unitOfMeasure": "Each"
|
||||
},
|
||||
"isObsolete": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"payload": {
|
||||
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"payload": {
|
||||
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"body": {}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"payload": {
|
||||
"transactionId": "mock-TransactionId-20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"request": {
|
||||
"parameters": {
|
||||
"body": {}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"payload": {
|
||||
"transactionId": "mock-TransactionId-20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -29,7 +29,7 @@
|
|||
"tags": [
|
||||
"vendorPayments"
|
||||
],
|
||||
"description": "Submit new invoices to Amazon.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 10 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe 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.",
|
||||
"description": "Submit new invoices to Amazon.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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": "submitInvoices",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -318,18 +318,18 @@
|
|||
"id": "TestInvoice202",
|
||||
"date": "2020-06-08T12:00:00.000Z",
|
||||
"billToParty": {
|
||||
"partyId": "TES1"
|
||||
},
|
||||
"invoiceType": "Invoice",
|
||||
"remitToParty": {
|
||||
"partyId": "ABCDE"
|
||||
},
|
||||
"invoiceTotal": {
|
||||
"amount": "112.05",
|
||||
"currencyCode": "USD"
|
||||
"partyId": "TES1"
|
||||
},
|
||||
"invoiceType": "Invoice",
|
||||
"remitToParty": {
|
||||
"partyId": "ABCDE"
|
||||
},
|
||||
"invoiceTotal": {
|
||||
"amount": "112.05",
|
||||
"currencyCode": "USD"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -370,24 +370,24 @@
|
|||
"invoiceType": "Invoic"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"errors": [
|
||||
{
|
||||
"code": "InvalidInput",
|
||||
"message": "Value 'Invoic' is not valid with respect to enumeration '[CreditNote, Invoice]'. It must be a value from the enumeration.",
|
||||
"details": ""
|
||||
},
|
||||
{
|
||||
"code": "InvalidInput",
|
||||
"message": "The value 'Invoic' of element 'invoiceType' is not valid.",
|
||||
"details": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"errors": [
|
||||
{
|
||||
"code": "InvalidInput",
|
||||
"message": "Value 'Invoic' is not valid with respect to enumeration '[CreditNote, Invoice]'. It must be a value from the enumeration.",
|
||||
"details": ""
|
||||
},
|
||||
{
|
||||
"code": "InvalidInput",
|
||||
"message": "The value 'Invoic' of element 'invoiceType' is not valid.",
|
||||
"details": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
"tags": [
|
||||
"vendorOrders"
|
||||
],
|
||||
"description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 10 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe 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.",
|
||||
"description": "Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the createdAfter, createdBefore, changedAfter and changedBefore parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting includeDetails to false. You can then use the getPurchaseOrder operation to receive details for a specific purchase order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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": "getPurchaseOrders",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1153,7 +1153,7 @@
|
|||
"tags": [
|
||||
"vendorOrders"
|
||||
],
|
||||
"description": "Returns a purchase order based on the purchaseOrderNumber value that you specify.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 10 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe 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.",
|
||||
"description": "Returns a purchase order based on the purchaseOrderNumber value that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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": "getPurchaseOrder",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1558,7 +1558,7 @@
|
|||
"tags": [
|
||||
"vendorOrders"
|
||||
],
|
||||
"description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 10 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe 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.",
|
||||
"description": "Submits acknowledgements for one or more purchase orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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": "submitAcknowledgement",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -1862,7 +1862,7 @@
|
|||
"tags": [
|
||||
"vendorOrders"
|
||||
],
|
||||
"description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 10 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe 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.",
|
||||
"description": "Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 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": "getPurchaseOrdersStatus",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -0,0 +1,432 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"type": "object",
|
||||
"description": "Forecast customer demand of your products for production and inventory planning purposes.",
|
||||
"examples": [
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_VENDOR_FORECASTING_REPORT",
|
||||
"reportOptions": {
|
||||
"sellingProgram": "RETAIL"
|
||||
},
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"forecastByAsin": [
|
||||
{
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-06-20",
|
||||
"endDate": "2021-06-26",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-06-27",
|
||||
"endDate": "2021-07-03",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-07-04",
|
||||
"endDate": "2021-07-10",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-07-11",
|
||||
"endDate": "2021-07-17",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-07-18",
|
||||
"endDate": "2021-07-24",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-07-25",
|
||||
"endDate": "2021-07-31",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-08-01",
|
||||
"endDate": "2021-08-07",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-08-08",
|
||||
"endDate": "2021-08-14",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-08-15",
|
||||
"endDate": "2021-08-21",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-08-22",
|
||||
"endDate": "2021-08-28",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-08-29",
|
||||
"endDate": "2021-09-04",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-09-05",
|
||||
"endDate": "2021-09-11",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-09-12",
|
||||
"endDate": "2021-09-18",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-09-19",
|
||||
"endDate": "2021-09-25",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-09-26",
|
||||
"endDate": "2021-10-02",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-10-03",
|
||||
"endDate": "2021-10-09",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-10-10",
|
||||
"endDate": "2021-10-16",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-10-17",
|
||||
"endDate": "2021-10-23",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-10-24",
|
||||
"endDate": "2021-10-30",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-10-31",
|
||||
"endDate": "2021-11-06",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-11-07",
|
||||
"endDate": "2021-11-13",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-11-14",
|
||||
"endDate": "2021-11-20",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-11-21",
|
||||
"endDate": "2021-11-27",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-11-28",
|
||||
"endDate": "2021-12-04",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}, {
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-12-05",
|
||||
"endDate": "2021-12-11",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.9,
|
||||
"p80ForecastUnits": 30.3,
|
||||
"p90ForecastUnits": 300.7
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportSpecification",
|
||||
"forecastByAsin"
|
||||
],
|
||||
"properties": {
|
||||
"reportSpecification": {
|
||||
"type": "object",
|
||||
"description": "Report input summary which includes the marketplace and selling program.",
|
||||
"examples": [
|
||||
{
|
||||
"reportType": "GET_VENDOR_FORECASTING_REPORT",
|
||||
"reportOptions": {
|
||||
"sellingProgram": "RETAIL"
|
||||
},
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportType",
|
||||
"reportOptions",
|
||||
"marketplaceIds"
|
||||
],
|
||||
"properties": {
|
||||
"reportType": {
|
||||
"type": "string",
|
||||
"description": "The report type.",
|
||||
"enum": [
|
||||
"GET_VENDOR_FORECASTING_REPORT"
|
||||
]
|
||||
},
|
||||
"reportOptions": {
|
||||
"type": "object",
|
||||
"description": "Report options specifying parameters such as sellingProgram.",
|
||||
"examples": [
|
||||
{
|
||||
"sellingProgram": "RETAIL"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"sellingProgram"
|
||||
],
|
||||
"properties": {
|
||||
"sellingProgram": {
|
||||
"type": "string",
|
||||
"description": "The selling program.",
|
||||
"enum": [
|
||||
"RETAIL",
|
||||
"FRESH"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"type": "array",
|
||||
"description": "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.",
|
||||
"examples": [
|
||||
[
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"forecastByAsin": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ForecastByAsin"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"ForecastByAsin": {
|
||||
"type": "object",
|
||||
"description": "Describes forecast units for a particular ASIN for a specific period of time in the future.",
|
||||
"examples": [
|
||||
{
|
||||
"forecastGenerationDate": "2021-06-06",
|
||||
"asin": "B123456789",
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"meanForecastUnits": 3.1,
|
||||
"p70ForecastUnits": 3.7,
|
||||
"p80ForecastUnits": 30.2,
|
||||
"p90ForecastUnits": 300.8
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"forecastGenerationDate",
|
||||
"asin",
|
||||
"startDate",
|
||||
"endDate",
|
||||
"meanForecastUnits",
|
||||
"p70ForecastUnits",
|
||||
"p80ForecastUnits",
|
||||
"p90ForecastUnits"
|
||||
],
|
||||
"properties": {
|
||||
"forecastGenerationDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The date that the forecast was generated.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"asin": {
|
||||
"description": "The Amazon Standard Identification Number.",
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"B123456789"
|
||||
]
|
||||
},
|
||||
"startDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The start date of the time period being forecasted. The forecasted time period includes this date.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The end date of the time period being forecasted. The forecasted time period includes this date.",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"meanForecastUnits": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The average amount of forecast units that Amazon has predicted for this date range. This means that, on average, Amazon predicts that this many stock units will be purchased during this date range.",
|
||||
"examples": [
|
||||
1.25
|
||||
]
|
||||
},
|
||||
"p70ForecastUnits": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The 70th percentile of forecast units that Amazon has predicted for this date range. This means that Amazon has forecasted a 70% probability that the ASIN will not run out of stock during the date range if this many units of inventory are present at the start of the date range.",
|
||||
"examples": [
|
||||
2.25
|
||||
]
|
||||
},
|
||||
"p80ForecastUnits": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The 80th percentile of forecast units that Amazon has predicted for this date range. This means that Amazon has forecasted an 80% probability that the ASIN will not run out of stock during the date range if this many units of inventory are present at the start of the date range.",
|
||||
"examples": [
|
||||
3.25
|
||||
]
|
||||
},
|
||||
"p90ForecastUnits": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The 90th percentile of forecast units that Amazon has predicted for this date range. This means that Amazon has forecasted a 90% probability that the ASIN will not run out of stock during the date range if this many units of inventory are present at the start of the date range.",
|
||||
"examples": [
|
||||
4.25
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,820 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"type": "object",
|
||||
"description": "This report shares inventory data of a vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods. For example, if the customer specified reportPeriod=WEEK and a dataStartTime and dataEndTime that are 3 weeks apart, the report would contain data for each of those 3 contiguous weeks.",
|
||||
"examples": [
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_VENDOR_INVENTORY_REPORT",
|
||||
"reportOptions": {
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL",
|
||||
"distributorView": "MANUFACTURING"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"inventoryAggregate": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"vendorConfirmationRate": 0.88,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 278,
|
||||
"openPurchaseOrderUnits": 123,
|
||||
"averageVendorLeadTimeDays": 10.2,
|
||||
"sellThroughRate": 0.88,
|
||||
"unfilledCustomerOrderedUnits": 12,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 43123.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 5490,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 881,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 123.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 2234,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 123.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 114,
|
||||
"procurableProductOutOfStockRate": 0.72,
|
||||
"uft": 0.19,
|
||||
"receiveFillRate": 0.67
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"vendorConfirmationRate": 0.98,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 4335.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 123,
|
||||
"openPurchaseOrderUnits": 422,
|
||||
"averageVendorLeadTimeDays": 5.2,
|
||||
"sellThroughRate": 0.98,
|
||||
"unfilledCustomerOrderedUnits": 3,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 43123.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 4490,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 3345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 881,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 323.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 2234,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 323.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 314,
|
||||
"procurableProductOutOfStockRate": 0.73,
|
||||
"uft": 0.18,
|
||||
"receiveFillRate": 0.77
|
||||
}
|
||||
],
|
||||
"inventoryByAsin": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"vendorConfirmationRate": 0.88,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 278,
|
||||
"openPurchaseOrderUnits": 123,
|
||||
"averageVendorLeadTimeDays": 10.2,
|
||||
"sellThroughRate": 0.88,
|
||||
"unfilledCustomerOrderedUnits": 12,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 43123.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 5490,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 881,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 123.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 2234,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 123.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 114,
|
||||
"procurableProductOutOfStockRate": 0.47,
|
||||
"uft": 0.26,
|
||||
"receiveFillRate": 0.98
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B987654321",
|
||||
"vendorConfirmationRate": 0.22,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 235.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 78,
|
||||
"openPurchaseOrderUnits": 23,
|
||||
"averageVendorLeadTimeDays": 1.2,
|
||||
"sellThroughRate": 0.28,
|
||||
"unfilledCustomerOrderedUnits": 1,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 123.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 590,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 245.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 81,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 13.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 234,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 23.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 14,
|
||||
"procurableProductOutOfStockRate": 0.25,
|
||||
"uft": 0.49,
|
||||
"receiveFillRate": 0.81
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B123456789",
|
||||
"vendorConfirmationRate": 0.12,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 2325.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 728,
|
||||
"openPurchaseOrderUnits": 13,
|
||||
"averageVendorLeadTimeDays": 15.2,
|
||||
"sellThroughRate": 0.128,
|
||||
"unfilledCustomerOrderedUnits": 12,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 1223.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 90,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 1245.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 811,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 123.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 2134,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 231.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 141,
|
||||
"procurableProductOutOfStockRate": 0.89,
|
||||
"uft": 0.67,
|
||||
"receiveFillRate": 0.45
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"vendorConfirmationRate": 0.412,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 1325.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 7228,
|
||||
"openPurchaseOrderUnits": 113,
|
||||
"averageVendorLeadTimeDays": 5.2,
|
||||
"sellThroughRate": 1.128,
|
||||
"unfilledCustomerOrderedUnits": 122,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 12223.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 900,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 11245.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 1811,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 1123.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 1134,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 2231.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 241,
|
||||
"procurableProductOutOfStockRate": 0.33,
|
||||
"uft": 0.22,
|
||||
"receiveFillRate": 0.11
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportSpecification",
|
||||
"inventoryAggregate",
|
||||
"inventoryByAsin"
|
||||
],
|
||||
"properties": {
|
||||
"reportSpecification": {
|
||||
"type": "object",
|
||||
"description": "Report summary including a reporting date range, distributor view, and selling program in the input.",
|
||||
"examples": [
|
||||
{
|
||||
"reportType": "GET_VENDOR_INVENTORY_REPORT",
|
||||
"reportOptions": {
|
||||
"distributorView": "MANUFACTURING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportType",
|
||||
"reportOptions",
|
||||
"dataStartTime",
|
||||
"dataEndTime",
|
||||
"marketplaceIds"
|
||||
],
|
||||
"properties": {
|
||||
"reportType": {
|
||||
"type": "string",
|
||||
"description": "The type of report.",
|
||||
"enum": [
|
||||
"GET_VENDOR_INVENTORY_REPORT"
|
||||
]
|
||||
},
|
||||
"reportOptions": {
|
||||
"type": "object",
|
||||
"description": "Report options specifying parameters such as reportPeriod, distributorView, and sellingProgram.",
|
||||
"examples": [
|
||||
{
|
||||
"distributorView": "MANUFACTURING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"distributorView",
|
||||
"reportPeriod",
|
||||
"sellingProgram"
|
||||
],
|
||||
"properties": {
|
||||
"distributorView": {
|
||||
"type": "string",
|
||||
"description": "The distributor view.",
|
||||
"enum": [
|
||||
"MANUFACTURING",
|
||||
"SOURCING"
|
||||
]
|
||||
},
|
||||
"reportPeriod": {
|
||||
"type": "string",
|
||||
"description": "Determines what granularity of data is expected in the report. Valid values are: WEEK, MONTH, QUARTER, YEAR.",
|
||||
"enum": [
|
||||
"WEEK",
|
||||
"MONTH",
|
||||
"QUARTER",
|
||||
"YEAR"
|
||||
]
|
||||
},
|
||||
"sellingProgram": {
|
||||
"type": "string",
|
||||
"description": "The selling program.",
|
||||
"enum": [
|
||||
"RETAIL",
|
||||
"FRESH"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"dataStartTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"dataEndTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.",
|
||||
"examples": [
|
||||
"2021-06-19"
|
||||
]
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"type": "array",
|
||||
"description": "This parameter must match the marketplaceId of the selling partner account (each selling partner account belongs to only one marketplaceId).",
|
||||
"examples": [
|
||||
[
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"inventoryAggregate": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/InventoryAggregate"
|
||||
}
|
||||
},
|
||||
"inventoryByAsin": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/InventoryByAsin"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"InventoryAggregate": {
|
||||
"type": "object",
|
||||
"description": "Describes the aggregated inventory metrics for all ASINs in the vendor's account.",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"vendorConfirmationRate": 0.88,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 278,
|
||||
"openPurchaseOrderUnits": 123,
|
||||
"averageVendorLeadTimeDays": 10.2,
|
||||
"sellThroughRate": 0.88,
|
||||
"unfilledCustomerOrderedUnits": 12,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 43123.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 5490,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 881,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 123.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 2234,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 123.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 114
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"netReceivedInventoryCost",
|
||||
"netReceivedInventoryUnits",
|
||||
"openPurchaseOrderUnits",
|
||||
"sellableOnHandInventoryCost",
|
||||
"sellableOnHandInventoryUnits"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The start date of the aggregated data.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The end date of the aggregated data.",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"procurableProductOutOfStockRate": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The out of stock rate on all products that are procurable. This is calculated by out of stock glance views on a procurable ASIN divided by the total glance views.",
|
||||
"examples": [
|
||||
0.28,
|
||||
0.92
|
||||
]
|
||||
},
|
||||
"uft": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The percentage of time an ASIN is available to be shipped to the customer from a fulfillment center, versus the selection Amazon intended to carry.",
|
||||
"examples": [
|
||||
0.88,
|
||||
1.00
|
||||
]
|
||||
},
|
||||
"receiveFillRate": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The purchase order units received by Amazon in comparison to the purchase order units confirmed by the vendor. This is calculated as the received quantity divided by the confirmed quantity.",
|
||||
"examples": [
|
||||
1.00,
|
||||
0.12
|
||||
]
|
||||
},
|
||||
"vendorConfirmationRate": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested.",
|
||||
"examples": [
|
||||
0.88,
|
||||
1.12
|
||||
]
|
||||
},
|
||||
"netReceivedInventoryCost": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received."
|
||||
},
|
||||
"netReceivedInventoryUnits": {
|
||||
"type": "integer",
|
||||
"description": "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received.",
|
||||
"examples": [
|
||||
25
|
||||
]
|
||||
},
|
||||
"openPurchaseOrderUnits": {
|
||||
"type": "integer",
|
||||
"description": "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested.",
|
||||
"examples": [
|
||||
123
|
||||
]
|
||||
},
|
||||
"averageVendorLeadTimeDays": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers.",
|
||||
"examples": [
|
||||
10.12
|
||||
]
|
||||
},
|
||||
"sellThroughRate" : {
|
||||
"type": "number",
|
||||
"description": "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers.",
|
||||
"examples": [
|
||||
0.88
|
||||
]
|
||||
},
|
||||
"unfilledCustomerOrderedUnits": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"description": "The number of units that have been ordered (or pre-ordered) but have not yet shipped.",
|
||||
"examples": [
|
||||
114
|
||||
]
|
||||
},
|
||||
"sellableOnHandInventoryCost": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "The cost of the inventory in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall."
|
||||
},
|
||||
"sellableOnHandInventoryUnits": {
|
||||
"type": "integer",
|
||||
"description": "The number of units in Amazon fulfillment centers that is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall.",
|
||||
"examples": [
|
||||
5490
|
||||
]
|
||||
},
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"$ref": "#/definitions/PositiveAmount",
|
||||
"description": "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window."
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"description": "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window.",
|
||||
"examples": [
|
||||
881
|
||||
]
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. "
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": {
|
||||
"type": "integer",
|
||||
"description": "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon.",
|
||||
"examples": [
|
||||
2234
|
||||
]
|
||||
},
|
||||
"unhealthyInventoryCost": {
|
||||
"$ref": "#/definitions/PositiveAmount",
|
||||
"description": "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand."
|
||||
},
|
||||
"unhealthyInventoryUnits": {
|
||||
"minimum": 0,
|
||||
"type": "integer",
|
||||
"description": "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.",
|
||||
"examples": [
|
||||
114
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"InventoryByAsin": {
|
||||
"type": "object",
|
||||
"description": "Describes ASIN-aggregated inventory metrics for the vendor's account.",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"vendorConfirmationRate": 0.88,
|
||||
"netReceivedInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"netReceivedInventoryUnits": 278,
|
||||
"openPurchaseOrderUnits": 123,
|
||||
"averageVendorLeadTimeDays": 10.2,
|
||||
"sellThroughRate": 0.88,
|
||||
"unfilledCustomerOrderedUnits": 12,
|
||||
"sellableOnHandInventoryCost": {
|
||||
"amount": 43123.99,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"sellableOnHandInventoryUnits": 5490,
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"amount": 2345.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": 881,
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"amount": 123.50,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": 2234,
|
||||
"unhealthyInventoryCost": {
|
||||
"amount": 123.45,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"unhealthyInventoryUnits": 114
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"asin",
|
||||
"netReceivedInventoryCost",
|
||||
"netReceivedInventoryUnits",
|
||||
"openPurchaseOrderUnits",
|
||||
"sellableOnHandInventoryCost",
|
||||
"sellableOnHandInventoryUnits"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The start date of the aggregated data.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The end date of the aggregated data.",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"asin": {
|
||||
"description": "The Amazon Standard Identification Number.",
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"B123456789"
|
||||
]
|
||||
},
|
||||
"vendorConfirmationRate": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The number of units that were confirmed by the vendor, divided by the number of units Amazon asked for. This rate will be 1 if all units that were requested during this time window were confirmed. This rate can be larger than 1 if the vendor has confirmed a greater quantity of units than Amazon requested.",
|
||||
"examples": [
|
||||
0.88,
|
||||
1.12
|
||||
]
|
||||
},
|
||||
"netReceivedInventoryCost": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Cost of the inventory that Amazon received from the vendor, minus the cost of the inventory that was returned to the vendor. The cost returned to the vendor takes into account any products that were returned due to damaged merchandise. This number can be negative if more cost was returned than received."
|
||||
},
|
||||
"netReceivedInventoryUnits": {
|
||||
"type": "integer",
|
||||
"description": "Units received from the vendor minus any units that were returned to the vendor. This number can be negative if more units were returned than received.",
|
||||
"examples": [
|
||||
25
|
||||
]
|
||||
},
|
||||
"openPurchaseOrderUnits": {
|
||||
"type": "integer",
|
||||
"description": "Number of units contained in Amazon’s confirmed purchase orders that are not yet received by Amazon. This number can be negative if the vendor has shipped more units than Amazon has requested.",
|
||||
"examples": [
|
||||
123
|
||||
]
|
||||
},
|
||||
"averageVendorLeadTimeDays": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "Average number of days between the submission of each purchase order unit and the time of receipt in Amazon's fulfillment centers.",
|
||||
"examples": [
|
||||
10.12
|
||||
]
|
||||
},
|
||||
"sellThroughRate" : {
|
||||
"type": "number",
|
||||
"description": "The number of units shipped (less customer returns), divided by the sum of the number of units held by Amazon at the beginning of this time window and the number of units received during this time window. This number could be negative if more units were returned than were shipped. This number can be greater than 1 if some inventory was sold while in transit between fulfillment centers.",
|
||||
"examples": [
|
||||
0.88
|
||||
]
|
||||
},
|
||||
"unfilledCustomerOrderedUnits": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"description": "Number of units that have been ordered (or pre-ordered) but have not yet shipped.",
|
||||
"examples": [
|
||||
114
|
||||
]
|
||||
},
|
||||
"sellableOnHandInventoryCost": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "The cost of the inventory in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative cost, and can cause this value to be negative overall."
|
||||
},
|
||||
"sellableOnHandInventoryUnits": {
|
||||
"type": "integer",
|
||||
"description": "The number of units in Amazon fulfillment centers that is in sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall.",
|
||||
"examples": [
|
||||
5490
|
||||
]
|
||||
},
|
||||
"unsellableOnHandInventoryCost": {
|
||||
"$ref": "#/definitions/PositiveAmount",
|
||||
"description": "The cost of the inventory in Amazon fulfillment centers that is in unsellable condition on the last day of the selected time window."
|
||||
},
|
||||
"unsellableOnHandInventoryUnits": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"description": "The number of units in Amazon fulfillment centers that are in unsellable condition on the last day of the selected time window.",
|
||||
"examples": [
|
||||
881
|
||||
]
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryCost": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "The cost of the inventory in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as a negative cost, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon. "
|
||||
},
|
||||
"aged90PlusDaysSellableInventoryUnits": {
|
||||
"type": "integer",
|
||||
"description": "The number of units in Amazon fulfillment centers that is at least 90 days old, and is in a sellable condition on the last day of the selected time window. Backorders count as negative units, and can cause this value to be negative overall. Inventory age is computed based on when the inventory was received by Amazon.",
|
||||
"examples": [
|
||||
2234
|
||||
]
|
||||
},
|
||||
"unhealthyInventoryCost": {
|
||||
"$ref": "#/definitions/PositiveAmount",
|
||||
"description": "The cost of the excess inventory on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand."
|
||||
},
|
||||
"unhealthyInventoryUnits": {
|
||||
"minimum": 0,
|
||||
"type": "integer",
|
||||
"description": "The number of excess inventory units on the last day of the selected time window based on forecasted demand. Note that the forecasted demand may have already included some amount of excess inventory that makes economic sense to hold. This is the amount of inventory beyond the forecasted demand.",
|
||||
"examples": [
|
||||
114
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"Amount": {
|
||||
"type": "object",
|
||||
"examples": [
|
||||
{
|
||||
"amount": -10.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
{
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
{
|
||||
"amount": 20.00,
|
||||
"currencyCode": "EUR"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"amount",
|
||||
"currencyCode"
|
||||
],
|
||||
"properties": {
|
||||
"amount": {
|
||||
"type": "number",
|
||||
"description": "The amount.",
|
||||
"examples": [
|
||||
20.00
|
||||
]
|
||||
},
|
||||
"currencyCode": {
|
||||
"type": "string",
|
||||
"description": "Currency code of the amount. In ISO 4217 format.",
|
||||
"examples": [
|
||||
"USD",
|
||||
"EUR",
|
||||
"AUD",
|
||||
"JPY"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"PositiveAmount": {
|
||||
"type": "object",
|
||||
"examples": [
|
||||
{
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
{
|
||||
"amount": 20.00,
|
||||
"currencyCode": "EUR"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"amount",
|
||||
"currencyCode"
|
||||
],
|
||||
"properties": {
|
||||
"amount": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"description": "The amount.",
|
||||
"examples": [
|
||||
20.00
|
||||
]
|
||||
},
|
||||
"currencyCode": {
|
||||
"type": "string",
|
||||
"description": "Currency code of the amount. In ISO 4217 format.",
|
||||
"examples": [
|
||||
"USD",
|
||||
"EUR",
|
||||
"AUD",
|
||||
"JPY"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,248 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"type": "object",
|
||||
"description": "The Net Pure Product Margin report shares data with vendors on Amazon's profit margin selling the vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods.",
|
||||
"examples": [
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT",
|
||||
"reportOptions": {
|
||||
"reportPeriod": "WEEK"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"netPureProductMarginAggregate": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"netPureProductMargin": 0.1234
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"netPureProductMargin": 0.1234
|
||||
}
|
||||
],
|
||||
"netPureProductMarginByAsin": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"netPureProductMargin": 0.1234
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B987654321",
|
||||
"netPureProductMargin": 0.1234
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B123456789",
|
||||
"netPureProductMargin": 0.1234
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"netPureProductMargin": 0.1234
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportSpecification",
|
||||
"netPureProductMarginAggregate",
|
||||
"netPureProductMarginByAsin"
|
||||
],
|
||||
"properties": {
|
||||
"reportSpecification": {
|
||||
"type": "object",
|
||||
"description": "Summarizes the original report request.",
|
||||
"examples": [
|
||||
{
|
||||
"reportType": "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT",
|
||||
"reportOptions": {
|
||||
"reportPeriod": "WEEK"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportType",
|
||||
"reportOptions",
|
||||
"dataStartTime",
|
||||
"dataEndTime",
|
||||
"marketplaceIds"
|
||||
],
|
||||
"properties": {
|
||||
"reportType": {
|
||||
"type": "string",
|
||||
"description": "The report type.",
|
||||
"enum": [
|
||||
"GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT"
|
||||
]
|
||||
},
|
||||
"reportOptions": {
|
||||
"type": "object",
|
||||
"description": "Report options specifying parameters such as reportPeriod.",
|
||||
"required": [
|
||||
"reportPeriod"
|
||||
],
|
||||
"properties": {
|
||||
"reportPeriod": {
|
||||
"type": "string",
|
||||
"description": "Determines the period by which data in the report is aggregated. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR.",
|
||||
"enum": [
|
||||
"DAY",
|
||||
"WEEK",
|
||||
"MONTH",
|
||||
"QUARTER",
|
||||
"YEAR"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"dataStartTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"dataEndTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.",
|
||||
"examples": [
|
||||
"2021-06-19"
|
||||
]
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"type": "array",
|
||||
"description": "This parameter must match the marketplaceId of the vendor account. Each vendor account belongs to only one marketplaceId.",
|
||||
"examples": [
|
||||
["ATVPDKIKX0DER"]
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"netPureProductMarginAggregate": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/NetPureProductMarginAggregateDetails"
|
||||
}
|
||||
},
|
||||
"netPureProductMarginByAsin": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/NetPureProductMarginDetailsByAsin"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"NetPureProductMarginAggregateDetails": {
|
||||
"type": "object",
|
||||
"description": "Describes the aggregated net pure product margin for ASINs in the vendor's account.",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"netPureProductMargin": 0.1234
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"netPureProductMargin"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"description": "The start date of the aggregated data.",
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"description": "The end date of the aggregated data.",
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"netPureProductMargin": {
|
||||
"description": "A measure of Amazon's profitability considering Amazon's wholesale cost and vendor-funded cooperative marketing funds: (Product Revenue – Product COGS – Vendor Funded Coop) / Product Revenue. The value is a fraction with values between 0 and 1. To represent as a percentage, multiply the value by 100.",
|
||||
"type": "number",
|
||||
"examples": [
|
||||
0.1234
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"NetPureProductMarginDetailsByAsin": {
|
||||
"type": "object",
|
||||
"description": "Describes the aggregated ASIN-level net pure product margin for ASINs in the vendor's account.",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"netPureProductMargin": 0.1234
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"asin",
|
||||
"netPureProductMargin"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"description": "The start date of the aggregated ASIN-level data.",
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"description": "The end date of the aggregated ASIN-level data.",
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"asin": {
|
||||
"description": "The Amazon Standard Identification Number.",
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"B123456789"
|
||||
]
|
||||
},
|
||||
"netPureProductMargin": {
|
||||
"description": "A measure of Amazon's profitability considering Amazon's wholesale cost and vendor-funded cooperative marketing funds: (Product Revenue – Product COGS – Vendor Funded Coop) / Product Revenue. The value is a fraction with values between 0 and 1. To represent as a percentage, multiply the value by 100.",
|
||||
"type": "number",
|
||||
"examples": [
|
||||
0.1234
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,611 @@
|
|||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema",
|
||||
"type": "object",
|
||||
"description": "This report shares data on the sales performance of vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available at different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods.",
|
||||
"examples": [
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_VENDOR_SALES_REPORT",
|
||||
"reportOptions": {
|
||||
"distributorView": "MANUFACTURING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"salesAggregate": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 1500.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 75,
|
||||
"shippedCogs": {
|
||||
"amount": 90.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 200.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 10
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 0,
|
||||
"shippedCogs": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 0
|
||||
}
|
||||
],
|
||||
"salesByAsin": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 1000.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 25,
|
||||
"shippedCogs": {
|
||||
"amount": 50.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 150.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 5
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B987654321",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 500,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 50,
|
||||
"shippedCogs": {
|
||||
"amount": 40.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 50.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 5
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B123456789",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 0,
|
||||
"shippedCogs": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 0
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-13",
|
||||
"endDate": "2021-06-19",
|
||||
"asin": "B987654321",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 0,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 0,
|
||||
"shippedCogs": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 0
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_VENDOR_SALES_REPORT",
|
||||
"reportOptions": {
|
||||
"distributorView": "MANUFACTURING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "FRESH"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"salesAggregate": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"orderedRevenue": {
|
||||
"amount": 1500.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 75,
|
||||
"shippedCogs": {
|
||||
"amount": 90.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 200.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 10
|
||||
}
|
||||
],
|
||||
"salesByAsin": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"orderedRevenue": {
|
||||
"amount": 1500.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 75,
|
||||
"shippedCogs": {
|
||||
"amount": 90.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 200.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 10
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"reportSpecification": {
|
||||
"reportType": "GET_VENDOR_SALES_REPORT",
|
||||
"reportOptions": {
|
||||
"distributorView": "SOURCING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-12",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
},
|
||||
"salesAggregate": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"customerReturns": 0,
|
||||
"shippedCogs": {
|
||||
"amount": 90.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 200.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 10
|
||||
}
|
||||
],
|
||||
"salesByAsin": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"customerReturns": 0,
|
||||
"shippedCogs": {
|
||||
"amount": 50.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 150.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 5
|
||||
},
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B987654321",
|
||||
"customerReturns": 0,
|
||||
"shippedCogs": {
|
||||
"amount": 40.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 50.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 5
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportSpecification",
|
||||
"salesAggregate",
|
||||
"salesByAsin"
|
||||
],
|
||||
"properties": {
|
||||
"reportSpecification": {
|
||||
"type": "object",
|
||||
"description": "Report summary including reporting date range, distributor view, and selling program in the input.",
|
||||
"examples": [
|
||||
{
|
||||
"reportType": "GET_VENDOR_SALES_REPORT",
|
||||
"reportOptions": {
|
||||
"distributorView": "MANUFACTURING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL"
|
||||
},
|
||||
"dataStartTime": "2021-06-06",
|
||||
"dataEndTime": "2021-06-19",
|
||||
"marketplaceIds": [
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"reportType",
|
||||
"reportOptions",
|
||||
"dataStartTime",
|
||||
"dataEndTime",
|
||||
"marketplaceIds"
|
||||
],
|
||||
"properties": {
|
||||
"reportType": {
|
||||
"type": "string",
|
||||
"description": "The report type.",
|
||||
"enum": [
|
||||
"GET_VENDOR_SALES_REPORT"
|
||||
]
|
||||
},
|
||||
"reportOptions": {
|
||||
"type": "object",
|
||||
"description": "Report options specifying parameters such as reportPeriod, distributorView, and sellingProgram.",
|
||||
"examples": [
|
||||
{
|
||||
"distributorView": "MANUFACTURING",
|
||||
"reportPeriod": "WEEK",
|
||||
"sellingProgram": "RETAIL"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"distributorView",
|
||||
"reportPeriod",
|
||||
"sellingProgram"
|
||||
],
|
||||
"properties": {
|
||||
"distributorView": {
|
||||
"type": "string",
|
||||
"description": "The distributor view.",
|
||||
"enum": [
|
||||
"MANUFACTURING",
|
||||
"SOURCING"
|
||||
]
|
||||
},
|
||||
"reportPeriod": {
|
||||
"type": "string",
|
||||
"description": "Determines what granularity of data is expected in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR.",
|
||||
"enum": [
|
||||
"DAY",
|
||||
"WEEK",
|
||||
"MONTH",
|
||||
"QUARTER",
|
||||
"YEAR"
|
||||
]
|
||||
},
|
||||
"sellingProgram": {
|
||||
"type": "string",
|
||||
"description": "The selling program.",
|
||||
"enum": [
|
||||
"RETAIL",
|
||||
"BUSINESS",
|
||||
"FRESH"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"dataStartTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"dataEndTime": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.",
|
||||
"examples": [
|
||||
"2021-06-19"
|
||||
]
|
||||
},
|
||||
"marketplaceIds": {
|
||||
"type": "array",
|
||||
"description": "This parameter must match the marketplaceId of the selling partner account. Each selling partner account belongs to only one marketplaceId.",
|
||||
"examples": [
|
||||
[
|
||||
"ATVPDKIKX0DER"
|
||||
]
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"salesAggregate": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/SalesAggregate"
|
||||
}
|
||||
},
|
||||
"salesByAsin": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/SalesByAsin"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"SalesAggregate": {
|
||||
"type": "object",
|
||||
"description": "Describes aggregated sales metrics for ASINs in the vendor's account.",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 1500,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 75,
|
||||
"shippedCogs": {
|
||||
"amount": 90.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 200.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 10
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"shippedCogs",
|
||||
"shippedRevenue",
|
||||
"shippedUnits"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The start date of the aggregated data.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The end date of the aggregated data.",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"customerReturns": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"description": "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.",
|
||||
"examples": [
|
||||
0
|
||||
]
|
||||
},
|
||||
"orderedRevenue": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING."
|
||||
},
|
||||
"orderedUnits": {
|
||||
"type": "integer",
|
||||
"description": "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING.",
|
||||
"minimum": 0,
|
||||
"examples": [
|
||||
75
|
||||
]
|
||||
},
|
||||
"shippedCogs": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Revenue based on the cost of goods sold. Adjustments are made for returns."
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Revenue based on units shipped in the selected time frame. Adjustments are made for returns."
|
||||
},
|
||||
"shippedUnits": {
|
||||
"type": "integer",
|
||||
"description": "Number of units shipped to Amazon customers.",
|
||||
"minimum": 0,
|
||||
"examples": [
|
||||
10
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"SalesByAsin": {
|
||||
"type": "object",
|
||||
"description": "Describes aggregated ASIN-level sales metrics for ASINs in the vendor's account.",
|
||||
"examples": [
|
||||
{
|
||||
"startDate": "2021-06-06",
|
||||
"endDate": "2021-06-12",
|
||||
"asin": "B123456789",
|
||||
"customerReturns": 0,
|
||||
"orderedRevenue": {
|
||||
"amount": 1000.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"orderedUnits": 25,
|
||||
"shippedCogs": {
|
||||
"amount": 50.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"amount": 150.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"shippedUnits": 5
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"startDate",
|
||||
"endDate",
|
||||
"asin",
|
||||
"shippedCogs",
|
||||
"shippedRevenue",
|
||||
"shippedUnits"
|
||||
],
|
||||
"properties": {
|
||||
"startDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The start date of the aggregated ASIN-level data.",
|
||||
"examples": [
|
||||
"2021-06-06"
|
||||
]
|
||||
},
|
||||
"endDate": {
|
||||
"type": "string",
|
||||
"format": "date",
|
||||
"description": "The end date of the aggregated ASIN-level data.",
|
||||
"examples": [
|
||||
"2021-06-12"
|
||||
]
|
||||
},
|
||||
"asin": {
|
||||
"description": "The Amazon Standard Identification Number.",
|
||||
"type": "string",
|
||||
"examples": [
|
||||
"B123456789"
|
||||
]
|
||||
},
|
||||
"customerReturns": {
|
||||
"type": "integer",
|
||||
"description": "The quantity of units returned. This field is populated when sellingProgram is RETAIL or BUSINESS.",
|
||||
"minimum": 0,
|
||||
"examples": [
|
||||
0
|
||||
]
|
||||
},
|
||||
"orderedRevenue": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Ordered product sales in the selected time frame. Adjustments are made for returns. This field is populated when distributorView is MANUFACTURING"
|
||||
},
|
||||
"orderedUnits": {
|
||||
"type": "integer",
|
||||
"description": "Number of units ordered by Amazon customers. This field is populated when distributorView is MANUFACTURING",
|
||||
"minimum": 0,
|
||||
"examples": [
|
||||
25
|
||||
]
|
||||
},
|
||||
"shippedCogs": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Revenue based on the cost of goods sold. Adjustments are made for returns."
|
||||
},
|
||||
"shippedRevenue": {
|
||||
"$ref": "#/definitions/Amount",
|
||||
"description": "Revenue based on units shipped in the selected time frame. Adjustments are made for returns."
|
||||
},
|
||||
"shippedUnits": {
|
||||
"type": "integer",
|
||||
"description": "Number of units shipped to Amazon customers.",
|
||||
"minimum": 0,
|
||||
"examples": [
|
||||
5
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"Amount": {
|
||||
"type": "object",
|
||||
"examples": [
|
||||
{
|
||||
"amount": 0.00,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
{
|
||||
"amount": 20.00,
|
||||
"currencyCode": "EUR"
|
||||
}
|
||||
],
|
||||
"required": [
|
||||
"amount",
|
||||
"currencyCode"
|
||||
],
|
||||
"properties": {
|
||||
"amount": {
|
||||
"type": "number",
|
||||
"description": "The amount.",
|
||||
"examples": [
|
||||
20.00
|
||||
]
|
||||
},
|
||||
"currencyCode": {
|
||||
"type": "string",
|
||||
"description": "Currency code of the amount. In ISO 4217 format.",
|
||||
"examples": [
|
||||
"USD",
|
||||
"EUR",
|
||||
"AUD",
|
||||
"JPY"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue