Update Merchant Fulfillment v0 model with Benefits to ShippingService.
This commit is contained in:
Gibran Waldron
parent
0778c441e7
commit
8537cf9461
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "The Selling Partner API for Merchant Fulfillment helps you build applications that let sellers purchase shipping for non-Prime and Prime orders using Amazon’s Buy Shipping Services.",
|
||||
"description": "With the Selling Partner API for Merchant Fulfillment, you can build applications that sellers can use to purchase shipping for non-Prime and Prime orders using Amazon's Buy Shipping Services.",
|
||||
"version": "v0",
|
||||
"title": "Selling Partner API for Merchant Fulfillment",
|
||||
"contact": {
|
||||
|
|
@ -29,12 +29,13 @@
|
|||
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "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 are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "getEligibleShipmentServices",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Request schema for GetEligibleShipmentServices operation.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetEligibleShipmentServicesRequest"
|
||||
|
|
@ -43,7 +44,7 @@
|
|||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetEligibleShipmentServicesResponse"
|
||||
},
|
||||
|
|
@ -106,8 +107,8 @@
|
|||
"payload": {
|
||||
"ShippingServiceList": [
|
||||
{
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"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",
|
||||
|
|
@ -141,11 +142,17 @@
|
|||
{
|
||||
"LabelFormat": "PNG"
|
||||
}
|
||||
]
|
||||
],
|
||||
"Benefits": {
|
||||
"IncludedBenefits": [
|
||||
"CLAIMS_PROTECTED"
|
||||
],
|
||||
"ExcludedBenefits": []
|
||||
}
|
||||
},
|
||||
{
|
||||
"ShippingServiceName": "UPS Next Day Air Saver\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"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",
|
||||
|
|
@ -179,12 +186,23 @@
|
|||
{
|
||||
"LabelFormat": "PNG"
|
||||
}
|
||||
]
|
||||
],
|
||||
"Benefits": {
|
||||
"IncludedBenefits": [],
|
||||
"ExcludedBenefits": [
|
||||
{
|
||||
"Benefit": "CLAIMS_PROTECTED",
|
||||
"ReasonCodes": [
|
||||
"LATE_DELIVERY_RISK"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"TemporarilyUnavailableCarrierList": [
|
||||
{
|
||||
"CarrierName": "UPS\u00AE"
|
||||
"CarrierName": "UPS\\u00AE"
|
||||
},
|
||||
{
|
||||
"CarrierName": "DHLECOMMERCE"
|
||||
|
|
@ -278,15 +296,11 @@
|
|||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetEligibleShipmentServicesResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -327,10 +341,6 @@
|
|||
"$ref": "#/definitions/GetEligibleShipmentServicesResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -343,10 +353,6 @@
|
|||
"$ref": "#/definitions/GetEligibleShipmentServicesResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -359,10 +365,6 @@
|
|||
"$ref": "#/definitions/GetEligibleShipmentServicesResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -377,7 +379,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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "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 are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "getShipment",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -391,7 +393,7 @@
|
|||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetShipmentResponse"
|
||||
},
|
||||
|
|
@ -462,8 +464,8 @@
|
|||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\\u00AE",
|
||||
"CarrierName": "UPS\\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "",
|
||||
"ShipDate": "2019-10-28T18:00:00Z",
|
||||
|
|
@ -478,7 +480,18 @@
|
|||
"Amount": 0.0
|
||||
}
|
||||
},
|
||||
"RequiresAdditionalSellerInputs": false
|
||||
"RequiresAdditionalSellerInputs": false,
|
||||
"Benefits": {
|
||||
"IncludedBenefits": [],
|
||||
"ExcludedBenefits": [
|
||||
{
|
||||
"Benefit": "CLAIMS_PROTECTED",
|
||||
"ReasonCodes": [
|
||||
"LATE_DELIVERY_RISK"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"Label": {
|
||||
"Dimensions": {
|
||||
|
|
@ -541,15 +554,11 @@
|
|||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -590,10 +599,6 @@
|
|||
"$ref": "#/definitions/GetShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -606,10 +611,6 @@
|
|||
"$ref": "#/definitions/GetShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -622,10 +623,6 @@
|
|||
"$ref": "#/definitions/GetShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -638,7 +635,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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "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 are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "cancelShipment",
|
||||
"parameters": [
|
||||
{
|
||||
|
|
@ -652,7 +649,7 @@
|
|||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CancelShipmentResponse"
|
||||
},
|
||||
|
|
@ -723,8 +720,8 @@
|
|||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"ShippingServiceName": "UPS 2nd Day Air\\u00AE",
|
||||
"CarrierName": "UPS\\u00AE",
|
||||
"ShippingServiceId": "UPS_PTP_2ND_DAY_AIR",
|
||||
"ShippingServiceOfferId": "",
|
||||
"ShipDate": "2019-10-28T18:00:00Z",
|
||||
|
|
@ -798,15 +795,11 @@
|
|||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CancelShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -847,10 +840,6 @@
|
|||
"$ref": "#/definitions/CancelShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -863,10 +852,6 @@
|
|||
"$ref": "#/definitions/CancelShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -879,10 +864,6 @@
|
|||
"$ref": "#/definitions/CancelShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -897,12 +878,13 @@
|
|||
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "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 are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "createShipment",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Request schema for `CreateShipment` operation.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CreateShipmentRequest"
|
||||
|
|
@ -911,7 +893,7 @@
|
|||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CreateShipmentResponse"
|
||||
},
|
||||
|
|
@ -1018,8 +1000,8 @@
|
|||
"Unit": "oz"
|
||||
},
|
||||
"ShippingService": {
|
||||
"ShippingServiceName": "UPS 2nd Day Air\u00AE",
|
||||
"CarrierName": "UPS\u00AE",
|
||||
"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",
|
||||
|
|
@ -1036,7 +1018,13 @@
|
|||
"Amount": 0
|
||||
}
|
||||
},
|
||||
"RequiresAdditionalSellerInputs": false
|
||||
"RequiresAdditionalSellerInputs": false,
|
||||
"Benefits": {
|
||||
"IncludedBenefits": [
|
||||
"CLAIMS_PROTECTED"
|
||||
],
|
||||
"ExcludedBenefits": []
|
||||
}
|
||||
},
|
||||
"Label": {
|
||||
"Dimensions": {
|
||||
|
|
@ -1136,15 +1124,11 @@
|
|||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CreateShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1185,10 +1169,6 @@
|
|||
"$ref": "#/definitions/CreateShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1201,10 +1181,6 @@
|
|||
"$ref": "#/definitions/CreateShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1217,10 +1193,6 @@
|
|||
"$ref": "#/definitions/CreateShipmentResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1235,12 +1207,13 @@
|
|||
"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\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"description": "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 are applied to the requested operation when available. The preceding table 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, refer to [Usage Plans and Rate Limits in the SP-API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
|
||||
"operationId": "getAdditionalSellerInputs",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Request schema for the `GetAdditionalSellerInputs` operation.",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetAdditionalSellerInputsRequest"
|
||||
|
|
@ -1249,7 +1222,7 @@
|
|||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Success",
|
||||
"description": "Success.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetAdditionalSellerInputsResponse"
|
||||
},
|
||||
|
|
@ -1357,15 +1330,11 @@
|
|||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"description": "The request's authorization header is not formatted correctly or does not contain a valid token.",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/GetAdditionalSellerInputsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1406,10 +1375,6 @@
|
|||
"$ref": "#/definitions/GetAdditionalSellerInputsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1422,10 +1387,6 @@
|
|||
"$ref": "#/definitions/GetAdditionalSellerInputsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1438,10 +1399,6 @@
|
|||
"$ref": "#/definitions/GetAdditionalSellerInputsResponse"
|
||||
},
|
||||
"headers": {
|
||||
"x-amzn-RateLimit-Limit": {
|
||||
"type": "string",
|
||||
"description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
|
||||
},
|
||||
"x-amzn-RequestId": {
|
||||
"type": "string",
|
||||
"description": "Unique request reference identifier."
|
||||
|
|
@ -1462,7 +1419,7 @@
|
|||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"description": "An error code that identifies the type of error that occured."
|
||||
"description": "An error code that identifies the type of error that occurred."
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
|
|
@ -1569,7 +1526,11 @@
|
|||
"description": "The available shipping service options."
|
||||
},
|
||||
"AvailableFormatOptionsForLabel": {
|
||||
"$ref": "#/definitions/AvailableFormatOptionsForLabelList"
|
||||
"type": "array",
|
||||
"description": "The available label formats.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/LabelFormatOption"
|
||||
}
|
||||
},
|
||||
"AvailableFormatOptionsForLabelList": {
|
||||
"type": "array",
|
||||
|
|
@ -1812,15 +1773,61 @@
|
|||
"type": "string",
|
||||
"description": "An Amazon-defined order identifier, in 3-7-7 format."
|
||||
},
|
||||
"Benefits": {
|
||||
"type": "object",
|
||||
"description": "Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (for example, `CLAIMS_PROTECTED`) when sellers purchase shipping through Amazon. Benefit details are made available for any shipment placed on or after January 1st 2024 00:00 UTC.",
|
||||
"properties": {
|
||||
"IncludedBenefits": {
|
||||
"$ref": "#/definitions/IncludedBenefits"
|
||||
},
|
||||
"ExcludedBenefits": {
|
||||
"$ref": "#/definitions/ExcludedBenefits"
|
||||
}
|
||||
}
|
||||
},
|
||||
"IncludedBenefits": {
|
||||
"type": "array",
|
||||
"description": "A list of included benefits.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ExcludedBenefits": {
|
||||
"type": "array",
|
||||
"description": "A list of excluded benefits. Refer to the `ExcludeBenefit` object for further documentation.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/ExcludedBenefit"
|
||||
}
|
||||
},
|
||||
"ExcludedBenefit": {
|
||||
"type": "object",
|
||||
"description": "An object representing an excluded benefit that is excluded for a shipping offer or rate.",
|
||||
"properties": {
|
||||
"Benefit": {
|
||||
"description": "A benefit that is being excluded from a shipment.",
|
||||
"type": "string"
|
||||
},
|
||||
"ReasonCodes": {
|
||||
"$ref": "#/definitions/ExcludedBenefitReasonCodes"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ExcludedBenefitReasonCodes": {
|
||||
"type": "array",
|
||||
"description": "List of reasons (for example, `LATE_DELIVERY_RISK`) why a benefit is excluded for a shipping offer.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"CancelShipmentResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"payload": {
|
||||
"description": "The payload for the cancelShipment operation.",
|
||||
"description": "The payload for the `cancelShipment` operation.",
|
||||
"$ref": "#/definitions/Shipment"
|
||||
},
|
||||
"errors": {
|
||||
"description": "One or more unexpected errors occurred during the cancelShipment operation.",
|
||||
"description": "One or more unexpected errors occurred during the `cancelShipment` operation.",
|
||||
"$ref": "#/definitions/ErrorList"
|
||||
}
|
||||
},
|
||||
|
|
@ -1843,7 +1850,7 @@
|
|||
],
|
||||
"properties": {
|
||||
"ShipmentRequestDetails": {
|
||||
"description": "Shipment information required for creating a shipment.",
|
||||
"description": "Shipment information required to create a shipment.",
|
||||
"$ref": "#/definitions/ShipmentRequestDetails"
|
||||
},
|
||||
"ShippingServiceId": {
|
||||
|
|
@ -1875,7 +1882,7 @@
|
|||
"$ref": "#/definitions/Shipment"
|
||||
},
|
||||
"errors": {
|
||||
"description": "One or more unexpected errors occurred during the createShipment operation.",
|
||||
"description": "One or more unexpected errors occurred during the `createShipment` operation.",
|
||||
"$ref": "#/definitions/ErrorList"
|
||||
}
|
||||
},
|
||||
|
|
@ -1883,6 +1890,7 @@
|
|||
},
|
||||
"ItemLevelFields": {
|
||||
"type": "object",
|
||||
"description": "A list of item level fields.",
|
||||
"required": [
|
||||
"AdditionalInputs",
|
||||
"Asin"
|
||||
|
|
@ -1936,7 +1944,7 @@
|
|||
"$ref": "#/definitions/ItemLevelFieldsList"
|
||||
}
|
||||
},
|
||||
"description": "The payload for the getAdditionalSellerInputs operation."
|
||||
"description": "The payload for the `getAdditionalSellerInputs` operation."
|
||||
},
|
||||
"GetAdditionalSellerInputsResponse": {
|
||||
"type": "object",
|
||||
|
|
@ -1972,7 +1980,7 @@
|
|||
},
|
||||
"CustomTextForLabel": {
|
||||
"type": "string",
|
||||
"description": "Custom text to print on the label.\n\nNote: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.",
|
||||
"description": "Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support `CustomTextForLabel`.",
|
||||
"maxLength": 14
|
||||
},
|
||||
"DeliveryExperienceType": {
|
||||
|
|
@ -1987,15 +1995,15 @@
|
|||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "DeliveryConfirmationWithAdultSignature",
|
||||
"description": "Delivery confirmation with adult signature."
|
||||
"description": "Delivery confirmation with an adult signature."
|
||||
},
|
||||
{
|
||||
"value": "DeliveryConfirmationWithSignature",
|
||||
"description": "Delivery confirmation with signature. Required for DPD (UK)."
|
||||
"description": "Delivery confirmation with a signature. Required for DPD (UK)."
|
||||
},
|
||||
{
|
||||
"value": "DeliveryConfirmationWithoutSignature",
|
||||
"description": "Delivery confirmation without signature."
|
||||
"description": "Delivery confirmation without a signature."
|
||||
},
|
||||
{
|
||||
"value": "NoTracking",
|
||||
|
|
@ -2105,13 +2113,13 @@
|
|||
"$ref": "#/definitions/TermsAndConditionsNotAcceptedCarrierList"
|
||||
}
|
||||
},
|
||||
"description": "The payload for the getEligibleShipmentServices operation."
|
||||
"description": "The payload for the `getEligibleShipmentServices` operation."
|
||||
},
|
||||
"GetShipmentResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"payload": {
|
||||
"description": "The payload for the getShipment operation.",
|
||||
"description": "The payload for the `getShipment` operation.",
|
||||
"$ref": "#/definitions/Shipment"
|
||||
},
|
||||
"errors": {
|
||||
|
|
@ -2180,7 +2188,7 @@
|
|||
},
|
||||
"ItemList": {
|
||||
"type": "array",
|
||||
"description": "The list of items to be included in a shipment.",
|
||||
"description": "The list of items you want to include in a shipment.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Item"
|
||||
}
|
||||
|
|
@ -2317,25 +2325,26 @@
|
|||
},
|
||||
"PackageDimension": {
|
||||
"type": "number",
|
||||
"description": "Number that represents the given package dimension.",
|
||||
"format": "double"
|
||||
},
|
||||
"PackageDimensions": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"Length": {
|
||||
"description": "The length dimension. If you don't specify PredefinedPackageDimensions, you must specify the Length.",
|
||||
"description": "The length dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the length.",
|
||||
"$ref": "#/definitions/PackageDimension"
|
||||
},
|
||||
"Width": {
|
||||
"description": "The width dimension. If you don't specify PredefinedPackageDimensions, you must specify the Width.",
|
||||
"description": "The width dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the width.",
|
||||
"$ref": "#/definitions/PackageDimension"
|
||||
},
|
||||
"Height": {
|
||||
"description": "The height dimension. If you don't specify PredefinedPackageDimensions, you must specify the Height.",
|
||||
"description": "The height dimension. If you don't specify `PredefinedPackageDimensions`, you must specify the height.",
|
||||
"$ref": "#/definitions/PackageDimension"
|
||||
},
|
||||
"Unit": {
|
||||
"description": "The unit of measurement. If you don't specify PredefinedPackageDimensions, you must specify the Unit.",
|
||||
"description": "The unit of measurement. If you don't specify `PredefinedPackageDimensions`, you must specify the unit.",
|
||||
"$ref": "#/definitions/UnitOfLength"
|
||||
},
|
||||
"PredefinedPackageDimensions": {
|
||||
|
|
@ -2356,7 +2365,7 @@
|
|||
},
|
||||
"PredefinedPackageDimensions": {
|
||||
"type": "string",
|
||||
"description": "An enumeration of predefined parcel tokens. If you specify a PredefinedPackageDimensions token, you are not obligated to use a branded package from a carrier. For example, if you specify the FedEx_Box_10kg token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token.\n\nNote: Please note that carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for all details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate Envelope or Box.",
|
||||
"description": "An enumeration of predefined parcel tokens. If you specify a `PredefinedPackageDimensions` token, you are not obligated to use a branded package from a carrier. For example, if you specify the `FedEx_Box_10kg` token, you do not have to use that particular package from FedEx. You are only obligated to use a box that matches the dimensions specified by the token. Note: Carriers can have restrictions on the type of package allowed for certain ship methods. Check the carrier website for details. Example: Flat rate pricing is available when materials are sent by USPS in a USPS-produced Flat Rate envelope or box.",
|
||||
"enum": [
|
||||
"FedEx_Box_10kg",
|
||||
"FedEx_Box_25kg",
|
||||
|
|
@ -2670,14 +2679,14 @@
|
|||
"$ref": "#/definitions/Weight"
|
||||
},
|
||||
"Insurance": {
|
||||
"description": "If DeclaredValue was specified in a previous call to the createShipment operation, then Insurance indicates the amount that the carrier will use to insure the shipment. If DeclaredValue was not specified with a previous call to the createShipment operation, then the shipment will be insured for the carrier's minimum insurance amount, or the combined sale prices that the items are listed for in the shipment, whichever is less.",
|
||||
"description": "If you specify `DeclaredValue` in a previous call to the `createShipment` operation, then `Insurance` indicates the shipment insurance amount that the carrier uses. If `DeclaredValue` isn't with a previous call to the `createShipment` operation, then the shipment is insured for the carrier's minimum insurance amount, or the combined sale prices that the items are listed for in the shipment.",
|
||||
"$ref": "#/definitions/CurrencyAmount"
|
||||
},
|
||||
"ShippingService": {
|
||||
"$ref": "#/definitions/ShippingService"
|
||||
},
|
||||
"Label": {
|
||||
"description": "Data for creating a shipping label and dimensions for printing the label. If the shipment is canceled, an empty Label is returned.",
|
||||
"description": "Data for creating a shipping label and dimensions for printing the label. If the shipment is canceled, an empty label is returned.",
|
||||
"$ref": "#/definitions/Label"
|
||||
},
|
||||
"Status": {
|
||||
|
|
@ -2688,7 +2697,7 @@
|
|||
"$ref": "#/definitions/TrackingId"
|
||||
},
|
||||
"CreatedDate": {
|
||||
"description": "The date and time the shipment was created.",
|
||||
"description": "The date and time the shipment is created.",
|
||||
"$ref": "#/definitions/Timestamp"
|
||||
},
|
||||
"LastUpdatedDate": {
|
||||
|
|
@ -2696,7 +2705,7 @@
|
|||
"$ref": "#/definitions/Timestamp"
|
||||
}
|
||||
},
|
||||
"description": "The details of a shipment, including the shipment status."
|
||||
"description": "The details of a shipment. Includes the shipment status."
|
||||
},
|
||||
"ShipmentId": {
|
||||
"type": "string",
|
||||
|
|
@ -2737,7 +2746,7 @@
|
|||
"$ref": "#/definitions/Weight"
|
||||
},
|
||||
"MustArriveByDate": {
|
||||
"description": "The date by which the package must arrive to keep the promise to the customer, in ISO 8601 datetime format. If MustArriveByDate is specified, only shipping service offers that can be delivered by that date are returned.",
|
||||
"description": "The date by which the package must arrive to keep the promise to the customer, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date-time format. If `MustArriveByDate` is specified, only shipping service offers that can be delivered by that date are returned.",
|
||||
"$ref": "#/definitions/Timestamp"
|
||||
},
|
||||
"ShipDate": {
|
||||
|
|
@ -2767,15 +2776,15 @@
|
|||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "Purchased",
|
||||
"description": "The seller purchased a label by calling the createShipment operation."
|
||||
"description": "The seller purchased a label by calling the `createShipment` operation."
|
||||
},
|
||||
{
|
||||
"value": "RefundPending",
|
||||
"description": "The seller requested a label refund by calling the cancelShipment operation, and the refund request is being processed by the carrier.\n\nNote:\n\n* A seller can create a new shipment for an order while Status=RefundPending for a canceled shipment.\n* After a label refund is requested by calling the cancelShipment operation, the order status of the order remains \"Shipped\"."
|
||||
"description": "The seller requested a label refund by calling the `cancelShipment` operation, and the refund request is being processed by the carrier. Note: A seller can create a new shipment for an order while `Status=RefundPending` for a canceled shipment. After you request a label refund (by calling `cancelShipment`), the status of the order remains `Shipped`."
|
||||
},
|
||||
{
|
||||
"value": "RefundRejected",
|
||||
"description": "The label refund request was rejected by the carrier. A refund request is rejected for either of the following reasons:\n\n* The cancellation window has expired. Cancellation policies vary by carrier. For more information about carrier cancellation policies, see the Seller Central Help.\n* The carrier has already accepted the shipment for delivery."
|
||||
"description": "The label refund request is rejected by the carrier. A refund request is rejected because the cancellation window has expired, or the carrier has already accepted the shipment for delivery. Cancellation policies vary by carrier. For more information about carrier cancellation policies, refer to the Seller Central Help for your marketplace."
|
||||
},
|
||||
{
|
||||
"value": "RefundApplied",
|
||||
|
|
@ -2851,7 +2860,7 @@
|
|||
"properties": {
|
||||
"ShippingServiceName": {
|
||||
"type": "string",
|
||||
"description": "A plain text representation of a carrier's shipping service. For example, \"UPS Ground\" or \"FedEx Standard Overnight\". "
|
||||
"description": "A plain text representation of a carrier's shipping service. For example, UPS Ground or FedEx Standard Overnight. "
|
||||
},
|
||||
"CarrierName": {
|
||||
"type": "string",
|
||||
|
|
@ -2896,6 +2905,9 @@
|
|||
"RequiresAdditionalSellerInputs": {
|
||||
"type": "boolean",
|
||||
"description": "When true, additional seller inputs are required."
|
||||
},
|
||||
"Benefits": {
|
||||
"$ref": "#/definitions/Benefits"
|
||||
}
|
||||
},
|
||||
"description": "A shipping service offer made by a carrier."
|
||||
|
|
@ -2923,12 +2935,12 @@
|
|||
"$ref": "#/definitions/DeliveryExperienceType"
|
||||
},
|
||||
"DeclaredValue": {
|
||||
"description": "The declared value of the shipment. The carrier uses this value to determine the amount to use to insure the shipment. If DeclaredValue is greater than the carrier's minimum insurance amount, the seller is charged for the additional insurance as determined by the carrier. For information about optional insurance coverage, see the Seller Central Help [UK](https://sellercentral.amazon.co.uk/gp/help/200204080) [US](https://sellercentral.amazon.com/gp/help/200204080).",
|
||||
"description": "The declared value of the shipment. The carrier uses this value to determine the amount to use to insure the shipment. If `DeclaredValue` is greater than the carrier's minimum insurance amount, the seller is charged for the additional insurance as determined by the carrier. For information about optional insurance coverage, refer to the Seller Central Help: [UK](https://sellercentral.amazon.co.uk/gp/help/200204080), [US](https://sellercentral.amazon.com/gp/help/200204080).",
|
||||
"$ref": "#/definitions/CurrencyAmount"
|
||||
},
|
||||
"CarrierWillPickUp": {
|
||||
"type": "boolean",
|
||||
"description": "When true, the carrier will pick up the package.\n\nNote: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK)."
|
||||
"description": "When true, the carrier will pick up the package. Note: Scheduled carrier pickup is available only using Dynamex (US), DPD (UK), and Royal Mail (UK)."
|
||||
},
|
||||
"CarrierWillPickUpOption": {
|
||||
"$ref": "#/definitions/CarrierWillPickUpOption"
|
||||
|
|
@ -2978,7 +2990,7 @@
|
|||
},
|
||||
"StateOrProvinceCode": {
|
||||
"type": "string",
|
||||
"description": "The state or province code. **Note.** Required in the Canada, US, and UK marketplaces. Also required for shipments originating from China.",
|
||||
"description": "The state or province code. Note: Required in Canada, US, and UK marketplaces. Also required for shipments originating in China.",
|
||||
"maxLength": 30
|
||||
},
|
||||
"RejectedShippingService": {
|
||||
|
|
@ -2992,19 +3004,19 @@
|
|||
"properties": {
|
||||
"CarrierName": {
|
||||
"type": "string",
|
||||
"description": "The rejected shipping carrier name. e.g. USPS"
|
||||
"description": "The rejected shipping carrier name. For example, USPS."
|
||||
},
|
||||
"ShippingServiceName": {
|
||||
"type": "string",
|
||||
"description": "The rejected shipping service localized name. e.g. FedEx Standard Overnight"
|
||||
"description": "The rejected shipping service localized name. For example, FedEx Standard Overnight."
|
||||
},
|
||||
"ShippingServiceId": {
|
||||
"description": "The rejected shipping service identifier. e.g. FEDEX_PTP_STANDARD_OVERNIGHT",
|
||||
"description": "The rejected shipping service identifier. For example, `FEDEX_PTP_STANDARD_OVERNIGHT`.",
|
||||
"$ref": "#/definitions/ShippingServiceIdentifier"
|
||||
},
|
||||
"RejectionReasonCode": {
|
||||
"type": "string",
|
||||
"description": "A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX"
|
||||
"description": "A reason code meant to be consumed programatically. For example, `CARRIER_CANNOT_SHIP_TO_POBOX`."
|
||||
},
|
||||
"RejectionReasonMessage": {
|
||||
"type": "string",
|
||||
|
|
@ -3015,7 +3027,7 @@
|
|||
},
|
||||
"RejectedShippingServiceList": {
|
||||
"type": "array",
|
||||
"description": "List of services that were for some reason unavailable for this request",
|
||||
"description": "List of services that are for some reason unavailable for this request",
|
||||
"items": {
|
||||
"$ref": "#/definitions/RejectedShippingService"
|
||||
}
|
||||
|
|
@ -3062,6 +3074,7 @@
|
|||
},
|
||||
"Timestamp": {
|
||||
"type": "string",
|
||||
"description": "Date-time formatted timestamp.",
|
||||
"format": "date-time"
|
||||
},
|
||||
"TrackingId": {
|
||||
|
|
@ -3070,7 +3083,7 @@
|
|||
},
|
||||
"TransparencyCode": {
|
||||
"type": "string",
|
||||
"description": "The Transparency code associated with the item. The Transparency serial number that needs to be submitted can be determined by the following:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, which likely has the prefix **SN**. The serial number will be applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates."
|
||||
"description": "The transparency code associated with the item. Determine the transparency serial number with:\n\n**1D or 2D Barcode:** This has a **T** logo. Submit either the 29-character alpha-numeric identifier beginning with **AZ** or **ZA**, or the 38-character Serialized Global Trade Item Number (SGTIN).\n**2D Barcode SN:** Submit the 7- to 20-character serial number barcode, that likely has the prefix **SN**. The serial number is applied to the same side of the packaging as the GTIN (UPC/EAN/ISBN) barcode.\n**QR code SN:** Submit the URL that the QR code generates."
|
||||
},
|
||||
"TransparencyCodeList": {
|
||||
"type": "array",
|
||||
|
|
@ -3166,7 +3179,7 @@
|
|||
},
|
||||
{
|
||||
"value": "FL_OZ",
|
||||
"description": "Fluid Ounce - Imperial unit of volume."
|
||||
"description": "Fluid ounce - Imperial unit of volume."
|
||||
},
|
||||
{
|
||||
"value": "GAL",
|
||||
|
|
@ -3191,11 +3204,11 @@
|
|||
"description": "The measurement value."
|
||||
}
|
||||
},
|
||||
"description": "Liquid Volume."
|
||||
"description": "Liquid volume."
|
||||
},
|
||||
"DangerousGoodsDetails": {
|
||||
"type": "object",
|
||||
"description": "Details related to any dangerous goods/items that are being shipped.",
|
||||
"description": "Details related to any dangerous goods or items that are shipped.",
|
||||
"properties": {
|
||||
"UnitedNationsRegulatoryId" : {
|
||||
"type": "string",
|
||||
|
|
@ -3204,7 +3217,7 @@
|
|||
},
|
||||
"TransportationRegulatoryClass" : {
|
||||
"type": "string",
|
||||
"description": "The specific regulatory class of the item being shipped.",
|
||||
"description": "The specific regulatory class of the shipped item.",
|
||||
"pattern": "^[1-9](\\.[1-9])?$"
|
||||
},
|
||||
"PackingGroup" : {
|
||||
|
|
@ -3251,59 +3264,59 @@
|
|||
"x-docgen-enum-table-extension": [
|
||||
{
|
||||
"value": "PI965_SECTION_IA",
|
||||
"description": "Ion PI965 Section IA (LiBa)"
|
||||
"description": "Ion PI965 Section IA (LiBa)."
|
||||
},
|
||||
{
|
||||
"value": "PI965_SECTION_IB",
|
||||
"description": "Ion PI965 Section IB (LiBa)"
|
||||
"description": "Ion PI965 Section IB (LiBa)."
|
||||
},
|
||||
{
|
||||
"value": "PI965_SECTION_II",
|
||||
"description": "Ion PI965 Section II (LiBa)"
|
||||
"description": "Ion PI965 Section II (LiBa)."
|
||||
},
|
||||
{
|
||||
"value": "PI966_SECTION_I",
|
||||
"description": "Ion PI966 Section I (LiBa with equipment)"
|
||||
"description": "Ion PI966 Section I (LiBa with equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI966_SECTION_II",
|
||||
"description": "Ion PI966 Section II (LiBa with equipment)"
|
||||
"description": "Ion PI966 Section II (LiBa with equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI967_SECTION_I",
|
||||
"description": "Ion PI967 Section I (LiBa in equipment)"
|
||||
"description": "Ion PI967 Section I (LiBa in equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI967_SECTION_II",
|
||||
"description": "Ion PI967 Section II (LiBa in equipment)"
|
||||
"description": "Ion PI967 Section II (LiBa in equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI968_SECTION_IA",
|
||||
"description": "Metal PI968 Section IA (LiBa)"
|
||||
"description": "Metal PI968 Section IA (LiBa)."
|
||||
},
|
||||
{
|
||||
"value": "PI968_SECTION_IB",
|
||||
"description": "Metal PI968 Section IB (LiBa)"
|
||||
"description": "Metal PI968 Section IB (LiBa)."
|
||||
},
|
||||
{
|
||||
"value": "PI969_SECTION_I",
|
||||
"description": "Metal PI969 Section I (LiBa with equipment)"
|
||||
"description": "Metal PI969 Section I (LiBa with equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI969_SECTION_II",
|
||||
"description": "Metal PI969 Section II (LiBa with equipment)"
|
||||
"description": "Metal PI969 Section II (LiBa with equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI970_SECTION_I",
|
||||
"description": "Metal PI970 Section I (LiBa in equipment)"
|
||||
"description": "Metal PI970 Section I (LiBa in equipment)."
|
||||
},
|
||||
{
|
||||
"value": "PI970_SECTION_II",
|
||||
"description": "Metal PI970 Section II (LiBa in equipment)"
|
||||
"description": "Metal PI970 Section II (LiBa in equipment)."
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue