Reconciliation API v1 model

{
  "swagger": "2.0",
  "info": {
    "title": "Amazon Business API for Payment Reconciliation",
    "version": "2021-01-08",
    "description": "With the Amazon Business API for Payment Reconciliation, you can build applications that help Amazon Business customers get purchase-related information for reconciling business transactions.",
    "license": {
      "name": "Amazon Software License",
      "url": "https://aws.amazon.com/asl/"
    }
  },
  "externalDocs": {
    "description": "Learn more about Amazon Business",
    "url": "https://business.amazon.com"
  },
  "host": "api.business.amazon.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/reconciliation/2021-01-08/transactions": {
      "get": {
        "description": "Returns a paginated list of business transactions with feed dates that fall within the date range that you specify.\n\n**Usage Plan:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| .5 | 10 |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation.",
        "operationId": "getTransactions",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "feedStartDate",
            "in": "query",
            "required": true,
            "type": "string",
            "format": "date-time",
            "description": "The lower limit for the search range."
          },
          {
            "name": "feedEndDate",
            "required": true,
            "in": "query",
            "type": "string",
            "format": "date-time",
            "description": "The upper limit for the search range."
          },
          {
            "name": "nextPageToken",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "A page token returned in the response to your previous request. nextPageToken is returned when the number of results exceed the page size. To get the next page of results, include nextPageToken as the only parameter. When no nextPageToken value is returned there are no more pages to return."
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/TransactionsResponse"
            },
            "x-amazon-spds-sandbox-behaviors": [
              {
                "request": {
                  "parameters": {
                    "feedStartDate": {
                      "value": "2020-07-09T00:00:00"
                    },
                    "feedEndDate": {
                      "value": "2020-08-01T00:00:00"
                    }
                  }
                },
                "response": {
                  "transactions": [
                    {
                      "marketplaceId": "[marketplaceId]",
                      "transactionDate": "2020-07-17T12:51:55.000Z",
                      "feedDate": "2020-07-17T15:11:48.866Z",
                      "transactionType": "CHARGE",
                      "transactionId": "[transactionId]",
                      "shipTaxRate": "[shipTaxRate]",
                      "giftWrapTaxRate": "[giftWrapTaxRate]",
                      "legalEntityName": "[legalEntityName]",
                      "purchasingCustomerGroupName": "[purchasingCustomerGroupName]",
                      "amount": {
                        "currencyCode": "USD",
                        "amount": "2.0"
                      },
                      "paymentInstrumentType": "[paymentInstrumentType]",
                      "paymentInstrumentLast4Digits": "1234",
                      "buyer": {
                        "id": "[buyingCustomerId]",
                        "name": "[buyingCustomerName]",
                        "email": "[email protected]"
                      },
                      "payer": {
                        "id": "[payingCustomerId]",
                        "name": "[payingCustomerName]",
                        "email": "[email protected]"
                      },
                      "associatedTransactionDetails": [
                        {
                          "associatedTransactionId": "[associatedTransactionId]"
                        }
                      ],
                      "transactionLineItems": [
                        {
                          "refundReason": "[refundReason]",
                          "totalAmount": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "principalAmount": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "shippingCharge": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "regulatoryFee": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "giftWrappingCharge": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "discount": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "tax": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "unitPrice": {
                            "currencyCode": "USD",
                            "amount": "2.0"
                          },
                          "taxRate": "[taxRate]",
                          "orderId": "[orderId]",
                          "unspsc": "[UNSPSC]",
                          "orderLineItemId": "[orderLineItemId]",
                          "purchaseOrderNumber": "[purchaseOrderNumber]",
                          "purchaseOrderLineItemId": "[purchaseOrderLineItemId]",
                          "asin": "[asin]",
                          "productTitle": "[productTitle]",
                          "itemQuantity": 1,
                          "shipmentId": "[shipmentId]",
                          "shipmentDate": "2020-07-17T10:02:25.000Z",
                          "merchantLegalName": "[merchantName]",
                          "budgetId": "[budgetId]",
                          "businessOrderInfo": {
                            "glCode": "[glCode]",
                            "costCenter": "[costCenter]",
                            "location": "[location]",
                            "projectCode": "[projectCode]",
                            "department": "[department]",
                            "customField": "[customValue]"
                          }
                        }
                      ]
                    }
                  ],
                  "nextPageToken": "[nextPageToken]"
                }
              }
            ],
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-RequestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "400": {
            "description": "Request has missing or invalid parameters and cannot be parsed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "x-amazon-spds-sandbox-behaviors": [
              {
                "request": {
                  "parameters": {
                    "feedStartDate": {
                      "value": "[misformattedDate]"
                    },
                    "feedEndDate": {
                      "value": "2020-08-01T00:00:00"
                    }
                  }
                },
                "response": {
                  "errors": [
                    {
                      "code": "INVALID_REQUEST_PARAMETER",
                      "message": "Input date [misformattedDate] is not in the expected ISO8601 format."
                    }
                  ]
                }
              }
            ],
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "404": {
            "description": "The resource specified does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "429": {
            "description": "The frequency of requests was greater than allowed.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "500": {
            "description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "504": {
            "description": "A gateway timeout occurred.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "Your rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "/reconciliation/2021-01-08/invoices": {
      "post": {
        "description": "Returns the invoice details for the order line items provided in the request.",
        "operationId": "getInvoiceDetailsByOrderLineItems",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "invoiceDetailsByOrderLineItemsRequest",
            "required": true,
            "schema": {
              "$ref": "#/definitions/InvoiceDetailsByOrderLineItemsRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "schema": {
              "$ref": "#/definitions/InvoiceDetailsByOrderLineItemsResponse"
            },
            "x-amazon-spds-sandbox-behaviors": [
              {
                "request": {
                  "parameters": {
                    "body": {
                      "value":  {
                        "orderLineItems": [
                          {
                            "orderId": "[orderId1]",
                            "orderLineItemId": "[orderLineItemId1]",
                            "shipmentId": "[shipmentId1]"
                          },
                          {
                            "orderId": "[orderId2]",
                            "orderLineItemId": "[orderLineItemId2]",
                            "shipmentId": "[shipmentId2]"
                          }
                        ]
                      }
                    }
                  }
                },
                "response": {
                  "invoiceDetailsByOrderLineItems": [
                    {
                      "orderLineItem" : {
                        "orderId": "[orderId1]",
                        "orderLineItemId": "[orderLineItemId1]",
                        "shipmentId": "[shipmentId1]"
                      },
                      "invoiceDetails":  [
                        {
                          "invoiceNumber": "[invoiceNumber1]",
                          "invoiceDate": "2022-09-01T00:00:00Z"
                        }
                      ]
                    },
                    {
                      "orderLineItem" : {
                        "orderId": "[orderId2]",
                        "orderLineItemId": "[orderLineItemId2]",
                        "shipmentId": "[shipmentId2]"
                      },
                      "invoiceDetails":  [
                        {
                          "invoiceNumber": "[invoiceNumber2]",
                          "invoiceDate": "2022-09-01T00:00:00Z"
                        },
                        {
                          "invoiceNumber": "[invoiceNumber3]",
                          "invoiceDate": "2022-09-01T00:00:00Z"
                        }
                      ]
                    }
                  ]
                }
              }
            ],
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-RequestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "400": {
            "description": "The server could not process an API request due to missing or invalid parameters. Errors may include mistyping the API endpoint, a header name or value, or a query parameter.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "x-amazon-spds-sandbox-behaviors": [
              {
                "request": {
                  "parameters": {
                  }
                },
                "response": {
                  "errors": [
                    {
                      "code": "INVALID_REQUEST_PARAMETER",
                      "message": "Missing required request parameters."
                    }
                  ]
                }
              }
            ],
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "401": {
            "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "403": {
            "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "404": {
            "description": "The specified resource does not exist.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "429": {
            "description": "The request rate exceeded the allowed limit.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "500": {
            "description": "The server encountered an unexpected condition that prevented it from fulfilling the request.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          },
          "504": {
            "description": "A gateway timeout occurred.",
            "schema": {
              "$ref": "#/definitions/ErrorList"
            },
            "headers": {
              "x-amzn-RateLimit-Limit": {
                "description": "The allowed rate limit (requests per second) for this operation.",
                "type": "string"
              },
              "x-amzn-requestId": {
                "description": "Unique request reference identifier.",
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Money": {
      "description": "The monetary value.",
      "type": "object",
      "required": [
        "currencyCode",
        "amount"
      ],
      "properties": {
        "currencyCode": {
          "type": "string",
          "description": "The three-digit currency code, in ISO 4217 format."
        },
        "amount": {
          "description": "The currency amount.",
          "type": "string"
        }
      }
    },
    "TransactionsResponse": {
      "description": "The response schema for the getTransactions operation.",
      "type": "object",
      "required": [
        "transactions",
        "nextPageToken"
      ],
      "properties": {
        "transactions": {
          "description": "A list of transactions with feed dates that fall within the specified date range.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/Transaction"
          }
        },
        "nextPageToken": {
          "description": "A page token that is returned when the results of the call exceed the page size. To get another page of results, call the operation again, passing in this value with the nextPageToken parameter.",
          "type": "string"
        }
      }
    },
    "Customer": {
      "description": "A customer with a role in a transaction.",
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "description": "A unique customer identifier.",
          "type": "string"
        },
        "name": {
          "description": "The customer name.",
          "type": "string"
        },
        "email": {
          "description": "The customer email address.",
          "type": "string"
        }
      }
    },
    "Transaction": {
      "description": "A business transaction.",
      "type": "object",
      "properties": {
        "marketplaceId": {
          "description": "The identifier of the marketplace where the item was bought.",
          "type": "string"
        },
        "transactionDate": {
          "description": "The date when the transaction occurred.",
          "format": "date-time",
          "type": "string"
        },
        "feedDate": {
          "description": "The date after which you can successfully query the transaction with the getTransactions operation.",
          "format": "date-time",
          "type": "string"
        },
        "transactionType": {
          "description": "The type of transaction.",
          "type": "string",
          "enum": [
            "CHARGE",
            "REFUND",
            "OVERREFUND"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "CHARGE",
              "description": "Positive transaction amount."
            },
            {
              "value": "REFUND",
              "description": "Negative transaction amount."
            },
            {
              "value": "OVERREFUND",
              "description": "Additional refund."
            }
          ]
        },
        "transactionId": {
          "description": "The identifier for this transaction.",
          "type": "string"
        },
        "shipTaxRate": {
          "description": "The shipping tax rate for a transaction.",
          "type": "string"
        },
        "giftWrapTaxRate": {
          "description": "The gift wrap tax rate for a transaction.",
          "type": "string"
        },
        "legalEntityName": {
          "description": "The name of the Business Legal Entity on behalf of which the order was placed.",
          "type": "string"
        },
        "purchasingCustomerGroupName": {
          "description": "The name of the department under the Legal Entity on behalf of which the order was placed",
          "type": "string"
        },
        "amount": {
          "description": "The amount charged for a specific transaction. If the amount is not settled yet, this is the amount for which Amazon received an authorization.",
          "$ref": "#/definitions/Money"
        },
        "paymentInstrumentType": {
          "description": "The type of payment instrument, such as a credit card, pay by invoice, a bank account, a reward account, etc.",
          "type": "string"
        },
        "paymentInstrumentLast4Digits": {
          "description": "The last 4 digits of the payment instrument number.",
          "type": "string"
        },
        "buyer": {
          "description": "The customer account on behalf of which the order was placed.",
          "$ref": "#/definitions/Customer"
        },
        "payer": {
          "description": "The customer account that owns the payment instrument with which the order was paid.",
          "$ref": "#/definitions/Customer"
        },
        "associatedTransactionDetails": {
          "type": "array",
          "description": "A list of transaction details that are associated with this transaction. For example, if a payment is made with three different transactions (each using a different payment instrument), this list will contain associatedTransactionId values for the two other transactions associated with this transaction.",
          "items": {
            "$ref": "#/definitions/AssociatedTransactionDetail"
          }
        },
        "transactionLineItems": {
          "type": "array",
          "description": "A list of transaction line items.",
          "items": {
            "$ref": "#/definitions/TransactionLineItem"
          }
        }
      }
    },
    "TransactionLineItem": {
      "description": "A transaction line item.",
      "type": "object",
      "properties": {
        "refundReason": {
          "description": "The reason why a refund was issued.",
          "type": "string"
        },
        "totalAmount": {
          "description": "The total amount charged for the item. This is the principalAmount plus or minus any additional charges or credits.",
          "$ref": "#/definitions/Money"
        },
        "principalAmount": {
          "description": "The amount charged for the item, before applying any additional charges or credits.",
          "$ref": "#/definitions/Money"
        },
        "shippingCharge": {
          "description": "The shipping charge for the item.",
          "$ref": "#/definitions/Money"
        },
        "regulatoryFee": {
          "description": "The regulatory fee charged on the item.",
          "$ref": "#/definitions/Money"
        },
        "giftWrappingCharge": {
          "description": "The gift wrapping charge for the item.",
          "$ref": "#/definitions/Money"
        },
        "discount": {
          "description": "The discount applied to the item.",
          "$ref": "#/definitions/Money"
        },
        "tax": {
          "description": "The tax charged on the item.",
          "$ref": "#/definitions/Money"
        },
        "unitPrice": {
          "description": "The price per unit of the item.",
          "$ref": "#/definitions/Money"
        },
        "taxRate": {
          "description": "The tax rate associated with item.",
          "type": "string"
        },
        "orderId": {
          "description": "The Amazon order identifier associated with the item.",
          "type": "string"
        },
        "unspsc": {
          "description": "United Nations Standard Products and Services Code for the item.",
          "type": "string"
        },
        "orderLineItemId": {
          "description": "The order line item identifier for the item. This identifier is created by Amazon",
          "type": "string"
        },
        "purchaseOrderNumber": {
          "description": "The purchase order number associated with the item of a PPI order. This number is created by the buyer.",
          "type": "string"
        },
        "purchaseOrderLineItemId": {
          "description": "The purchase order line item identifier associated with the item. This identifier is created by the buyer.",
          "type": "string"
        },
        "asin": {
          "description": "The Amazon Standard Identification Number (ASIN) for the item.",
          "type": "string"
        },
        "productTitle": {
          "description": "The title of the item.",
          "type": "string"
        },
        "itemQuantity": {
          "description": "The item quantity relevant to this transaction.",
          "type": "integer"
        },
        "shipmentId": {
          "description": "The identifier of the shipment associated with the item. This identifier is created by Amazon.",
          "type": "string"
        },
        "shipmentDate": {
          "description": "The shipment date associated with the item.",
          "format": "date-time",
          "type": "string"
        },
        "merchantLegalName": {
          "description": "The legal name of the seller.",
          "type": "string"
        },
        "budgetId": {
          "description": "The budget identifier associated with the item.",
          "type": "string"
        },
        "businessOrderInfo": {
          "type": "object",
          "description": "Additional order information configured by administrators that requisitioners must enter at checkout.",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "AssociatedTransactionDetail": {
      "description": "A transaction detail that is associated with this transaction.",
      "type": "object",
      "required": [
        "associatedTransactionId"
      ],
      "properties": {
        "associatedTransactionId": {
          "description": "The identifier for an associated transaction.",
          "type": "string"
        }
      }
    },
    "InvoiceDetailsByOrderLineItemsRequest": {
      "description": "The request schema for the getInvoiceDetailsByOrderLineItems operation.",
      "type": "object",
      "required": [
        "orderLineItems"
      ],
      "properties": {
        "orderLineItems": {
          "description": "List of order line items for the requested invoice details. The maximum number of order line items listed in each call is 25.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/OrderLineItem"
          }
        }
      }
    },
    "InvoiceDetailsByOrderLineItemsResponse": {
      "description": "The response schema for the getInvoiceDetailsByOrderLineItems operation",
      "type": "object",
      "required": [
        "invoiceDetailsByOrderLineItems"
      ],
      "properties": {
        "invoiceDetailsByOrderLineItems": {
          "description": "Lists the invoices that includes order line item and invoice details.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/InvoiceDetailsOfOrderLineItem"
          }
        }
      }
    },
    "InvoiceDetailsOfOrderLineItem": {
      "description": "Invoice details with the corresponding order line item.",
      "type": "object",
      "properties": {
        "orderLineItem": {
          "description": "The Order line item to which the invoice details are associated to.",
          "$ref": "#/definitions/OrderLineItem"
        },
        "invoiceDetails": {
          "description": "List of invoice detail for all invoices related to the order line item.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/InvoiceDetail"
          }
        }
      }
    },
    "InvoiceDetail": {
      "description": "The detailed information of an invoice.",
      "type": "object",
      "required": [
        "invoiceNumber",
        "invoiceDate"
      ],
      "properties": {
        "invoiceNumber": {
          "description": "The invoice number associated with the invoiceDetail.",
          "type": "string"
        },
        "invoiceDate": {
          "description": "The date and time an invoice was issued.",
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "OrderLineItem": {
      "description": "The identifiers for the order line item.",
      "type": "object",
      "required": [
        "orderId",
        "orderLineItemId",
        "shipmentId"
      ],
      "properties": {
        "orderId": {
          "description": "Amazon-generated order identifier associated with the orderLineItem.",
          "type": "string"
        },
        "orderLineItemId": {
          "description": "Amazon-generated item identifier associated with the orderLineItem..",
          "type": "string"
        },
        "shipmentId": {
          "description": "Amazon-generated shipment ID associated with the orderLineItem.",
          "type": "string"
        }
      }
    },
    "ErrorList": {
      "type": "object",
      "description": "A list of error responses for an unsuccessful request.",
      "required": [
        "errors"
      ],
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Error"
          }
        }
      }
    },
    "Error": {
      "description": "Error response returned when the request is unsuccessful.",
      "properties": {
        "code": {
          "description": "An error code that identifies the type of error that occurred.",
          "type": "string"
        },
        "message": {
          "description": "A message that describes the error condition.",
          "type": "string"
        },
        "details": {
          "description": "Additional details that can help the caller understand or fix the issue.",
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    }
  }
}