ShipEngine Documents API

Document Upload lets you submit self-prepared customs paperwork — such as Pro Forma Invoices, USMCA forms (for example, the USMCA Certification of Origin), and other supporting documents — directly to the carrier. Use it whenever a shipment requires supplemental international documentation, helping to prevent customs delays and delivery issues. Documents can be provided at either the **shipment level** or the **label level** — that is, before or after a label is generated: - **Shipment level (before a label exists).** Register the document with [Register a document for a shipment](#operation/register_shipment_document). Documents registered at the shipment level are forwarded to the carrier automatically. - **Label level (after a label is generated).** Register the document with [Register a document for a label](#operation/register_label_document), then call [Send label documents](#operation/send_label_documents) to transmit it to the carrier. To enable document upload for a shipment or label, set the `pending_documents` flag on the shipment's `customs` object. SS API: You can also suppress a carrier-generated document by setting the `suppress_carrier_generated_documents` [advanced option](/apis/@shipengine/docs/carriers/advanced-options.md) on the shipment. Currently, only the commercial invoice is supported, and only for UPS. Carrier Document Upload is currently supported for **UPS** and **FedEx** only. Accepted document types and file size vary by carrier — see the [Carrier Document Upload guide](/apis/@shipengine/docs/labels/carrier-document-upload.md) for the full list. For **step-by-step instructions on uploading documents through the ShipStation API dashboard**, see the [Customs Declarations: Document Upload help article](https://help.shipstation.com/hc/en-us/articles/50888603341211). This is useful for operations teams who need to upload documents manually or as a fallback if API integration issues occur.

GitHub OpenAPI

Operations 9

POST /v1/labels/{label_id}/documents Register a document for a label #
GET /v1/labels/{label_id}/documents List documents for a label #
DELETE /v1/labels/{label_id}/documents/{document_id} Delete a label document #
POST /v1/labels/{label_id}/documents/send Send label documents #
GET /v1/documents/{document_id}/download Download a document #
POST /v1/shipments/{shipment_id}/documents Register a document for a shipment #
GET /v1/shipments/{shipment_id}/documents List documents for a shipment #
DELETE /v1/shipments/{shipment_id}/documents/{document_id} Delete a shipment document #
GET /v1/shipments/{shipment_id}/labels List shipments and their document statuses #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/shipengine:shipengine-documents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shipengine-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Shipengine Documents API
  version: 1.1.202604070904
  contact:
    name: ShipEngine Sales & Support
    email: sales@shipengine.com
    url: https://www.shipengine.com/contact/
    x-phone: 1-512-856-5379
  license:
    name: Proprietary
    url: https://www.shipengine.com/terms-of-service/
  termsOfService: https://www.shipengine.com/terms-of-service/
  x-logo:
    url: https://shipengine.github.io/img/shipengine-logo-square.png
    backgroundColor: '#FFFFFF'
    altText: ShipEngine logo
  description: 'Operations tagged documents across 2 of this provider''s published API definitions: shipengine-openapi-docs-bundle.yaml, shipengine-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.shipengine.com
security:
- api_key: []
tags:
- name: Documents
  description: 'Document Upload lets you submit self-prepared customs paperwork — such as Pro Forma Invoices, USMCA forms (for example, the USMCA Certification of Origin), and other supporting documents — directly to the carrier. Use it whenever a shipment requires supplemental international documentation, helping to prevent customs delays and delivery issues.


    Documents can be provided at either the **shipment level** or the **label level** — that is, before or after a label is generated:


    - **Shipment level (before a label exists).** Register the document with Register a document for a shipment. Documents registered at the shipment level are forwarded to the carrier automatically.

    - **Label level (after a label is generated).** Register the document with Register a document for a label, then call Send label documents to transmit it to the carrier.


    To enable document upload for a shipment or label, set the `pending_documents` flag on the shipment''s `customs` object.


    SS API: You can also suppress a carrier-generated document by setting the `suppress_carrier_generated_documents` advanced option on the shipment. Currently, only the commercial invoice is supported, and only for UPS.


    Carrier Document Upload is currently supported for **UPS** and **FedEx** only. Accepted document types and file size vary by carrier — see the Carrier Document Upload guide for the full list.


    For **step-by-step instructions on uploading documents through the ShipStation API dashboard**, see the Customs Declarations: Document Upload help article. This is useful for operations teams who need to upload documents manually or as a fallback if API integration issues occur.'
  x-displayName: Documents
paths:
  /v1/labels/{label_id}/documents:
    summary: Carrier documents for a label
    description: 'Register, list, and manage carrier documents (such as commercial invoices and certificates of origin) for a purchased label. Carrier details are resolved automatically from the label.


      > **Note:** Carrier Document Upload is currently supported for **UPS** and **FedEx** only. Accepted document types and file size vary by carrier — please refer to the [Carrier Document Upload guide](/apis/@shipengine/docs/labels/carrier-document-upload.md) for the full list.

      '
    parameters:
    - name: label_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/se_id'
      description: Label ID
    post:
      summary: Register a document for a label
      description: Register a carrier document against a label. The response returns an `upload` target; upload the document file to that target, then call the send documents endpoint to transmit it to the carrier. Carrier information is resolved automatically from the label.
      tags:
      - Documents
      operationId: register_label_document
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/register_document_request_body'
      responses:
        '200':
          description: The document was registered successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/register_document_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    get:
      summary: List documents for a label
      description: Retrieve the carrier documents registered against a label, including their processing status.
      tags:
      - Documents
      operationId: list_label_documents
      responses:
        '200':
          description: The request was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list_documents_response_body'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
  /v1/labels/{label_id}/documents/{document_id}:
    summary: A carrier document for a label
    parameters:
    - name: label_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/se_id'
      description: Label ID
    - name: document_id
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier of the document.
      example: 7f3c1b2a-9d4e-4f5a-8c6b-2e1d0a9b8c7d
    delete:
      summary: Delete a label document
      description: Delete a carrier document registered against a label. Documents that have already been sent to the carrier cannot be deleted.
      tags:
      - Documents
      operationId: delete_label_document
      responses:
        '204':
          description: The document was deleted successfully.
        '404':
          $ref: '#/components/responses/404_error_response'
        '409':
          $ref: '#/components/responses/409_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
  /v1/labels/{label_id}/documents/send:
    summary: Send a label's documents to the carrier
    parameters:
    - name: label_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/se_id'
      description: Label ID
    post:
      summary: Send label documents
      description: Transmit all uploaded documents for a label to the carrier. Documents must be uploaded to their `upload` target before they can be sent.
      tags:
      - Documents
      operationId: send_label_documents
      responses:
        '200':
          description: The documents were sent to the carrier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/send_documents_response_body'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
        '503':
          description: The document service is temporarily unavailable. Try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_body'
    servers:
    - url: https://api.shipengine.com
  /v1/documents/{document_id}/download:
    summary: Download a carrier document
    parameters:
    - name: document_id
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier of the document.
      example: 7f3c1b2a-9d4e-4f5a-8c6b-2e1d0a9b8c7d
    get:
      summary: Download a document
      description: Download the file for a previously registered carrier document.
      tags:
      - Documents
      operationId: download_document
      responses:
        '200':
          description: The document file.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
        '404':
          $ref: '#/components/responses/404_error_response'
        '410':
          description: The document is invalid and cannot be downloaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_body'
        '425':
          description: The document is still being processed. Try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_body'
        '500':
          $ref: '#/components/responses/500_error_response'
        '503':
          description: The document service is temporarily unavailable. Try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_body'
    servers:
    - url: https://api.shipengine.com
  /v1/shipments/{shipment_id}/documents:
    summary: Carrier documents for a shipment
    description: 'Register, list, and manage carrier documents (such as commercial invoices and certificates of origin) for a shipment.


      > **Note:** Carrier Document Upload is currently supported for **UPS** and **FedEx** only. Accepted document types and file size vary by carrier — please refer to the [Carrier Document Upload guide](/apis/@shipengine/docs/labels/carrier-document-upload.md) for the full list.

      '
    parameters:
    - name: shipment_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/se_id'
      description: Shipment ID
    post:
      summary: Register a document for a shipment
      description: Register a carrier document against a shipment. The response returns an `upload` target; upload the document file to that target so it can later be sent to the carrier.
      tags:
      - Documents
      operationId: register_shipment_document
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/register_document_request_body'
      responses:
        '200':
          description: The document was registered successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/register_document_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    get:
      summary: List documents for a shipment
      description: Retrieve the carrier documents registered against a shipment, including their processing status.
      tags:
      - Documents
      operationId: list_shipment_documents
      responses:
        '200':
          description: The request was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list_documents_response_body'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
  /v1/shipments/{shipment_id}/documents/{document_id}:
    summary: A carrier document for a shipment
    parameters:
    - name: shipment_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/se_id'
      description: Shipment ID
    - name: document_id
      in: path
      required: true
      schema:
        type: string
      description: The unique identifier of the document.
      example: 7f3c1b2a-9d4e-4f5a-8c6b-2e1d0a9b8c7d
    delete:
      summary: Delete a shipment document
      description: Delete a carrier document registered against a shipment. Documents that have already been sent to the carrier cannot be deleted.
      tags:
      - Documents
      operationId: delete_shipment_document
      responses:
        '204':
          description: The document was deleted successfully.
        '404':
          $ref: '#/components/responses/404_error_response'
        '409':
          $ref: '#/components/responses/409_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
  /v1/shipments/{shipment_id}/labels:
    summary: Shipments and their document statuses
    description: 'Retrieve the shipments associated with the given id, each with its tracking number and the carrier documents registered against it.

      '
    parameters:
    - name: shipment_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/se_id'
      description: Shipment ID
    get:
      summary: List shipments and their document statuses
      description: Retrieve each shipment associated with the given id, including its tracking number and registered carrier documents.
      tags:
      - Documents
      operationId: list_shipment_label_documents
      responses:
        '200':
          description: The request was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list_shipment_labels_response_body'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
components:
  schemas:
    document_status:
      title: document_status
      type: object
      description: The current state of a carrier document.
      additionalProperties: false
      properties:
        document_id:
          type: string
          description: The unique identifier of the document.
          example: 7f3c1b2a-9d4e-4f5a-8c6b-2e1d0a9b8c7d
        type:
          allOf:
          - $ref: '#/components/schemas/document_type'
          description: The type of the document.
        file_name:
          type: string
          description: The file name of the document.
          example: usmca-certification-of-origin.pdf
        status:
          allOf:
          - $ref: '#/components/schemas/document_status_value'
          description: The processing status of the document.
        error:
          type:
          - string
          - 'null'
          description: A description of the error when the document is `invalid` or `failed`; otherwise `null`.
          example: The uploaded file could not be read.
        external_id:
          type:
          - string
          - 'null'
          description: The carrier-assigned identifier for the document once it has been sent; otherwise `null`.
          example: 1Z999AA10123456784
    error_response_body:
      title: error_response_body
      type: object
      description: An error response body
      required:
      - request_id
      - errors
      additionalProperties: false
      properties:
        request_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: 'A UUID that uniquely identifies the request id.

            This can be given to the support team to help debug non-trivial issues that may occur

            '
        errors:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/error'
          description: The errors associated with the failed API call
    se_id:
      title: se_id
      type: string
      minLength: 1
      maxLength: 25
      pattern: ^se(-[a-z0-9]+)+$
      example: se-28529731
      description: A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
    error_source:
      title: error_source
      type: string
      example: shipengine
      enum:
      - carrier
      - order_source
      - shipengine
      description: 'The source of the error, as indicated by the name this informs us if the API call failed because of the

        carrier, the order source, or the ShipEngine API itself.

        '
    list_documents_response_body:
      title: list_documents_response_body
      type: array
      description: The list of documents registered against the shipment or label.
      items:
        $ref: '#/components/schemas/document_status'
    error_code:
      title: error_code
      type: string
      example: invalid_field_value
      enum:
      - auto_fund_not_supported
      - batch_cannot_be_modified
      - bring_your_own_label_not_supported
      - carrier_conflict
      - carrier_disconnected
      - carrier_not_connected
      - carrier_not_supported
      - confirmation_not_supported
      - default_warehouse_cannot_be_deleted
      - field_conflict
      - field_value_required
      - forbidden
      - identifier_conflict
      - identifiers_must_match
      - insufficient_funds
      - invalid_address
      - invalid_billing_plan
      - invalid_field_value
      - invalid_identifier
      - invalid_status
      - invalid_string_length
      - label_images_not_supported
      - meter_failure
      - multiple_sales_orders
      - order_source_not_active
      - rate_limit_exceeded
      - refresh_not_supported
      - request_body_required
      - return_label_not_supported
      - sales_order_link_required
      - settings_not_supported
      - subscription_inactive
      - terms_not_accepted
      - tracking_not_supported
      - trial_expired
      - unauthorized
      - unknown
      - unspecified
      - verification_failure
      - warehouse_conflict
      - webhook_event_type_conflict
      - customs_items_required
      - incompatible_paired_labels
      - invalid_charge_event
      - invalid_object
      - no_rates_returned
      - file_not_found
      - shipping_rule_not_found
      - service_not_determined
      - funding_source_registration_in_progress
      - insurance_failure
      - funding_source_missing_configuration
      - funding_source_error
      - freight_connection_inactive
      - freight_provider_id_required
      - freight_provider_already_connected
      - freight_shipment_not_found
      - freight_tracking_not_available
      - freight_tracking_not_found
      - freight_shipment_not_batchable
      description: The error code specified for the failed API Call
    carrier_code:
      title: carrier_code
      type: string
      pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
      example: dhl_express
      description: 'A shipping carrier, such as `fedex`, `dhl_express`, `stamps_com`, etc.

        '
    uuid:
      title: uuid
      type: string
      format: uuid
      minLength: 36
      maxLength: 36
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      example: aa3d8e8e-462b-4476-9618-72db7f7b7009
      description: A UUID (a.k.a. GUID) that uniquely identifies a resource
    error:
      title: error
      type: object
      description: 'The error structure that gets returned with almost all failed API calls

        '
      required:
      - error_source
      - error_type
      - error_code
      - message
      additionalProperties: false
      properties:
        error_source:
          $ref: '#/components/schemas/error_source'
        error_type:
          $ref: '#/components/schemas/error_type'
        error_code:
          $ref: '#/components/schemas/error_code'
        message:
          type: string
          readOnly: true
          example: Body of request cannot be null.
          minLength: 1
          description: An error message associated with the failed API call
        carrier_id:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/se_id'
          description: A string that uniquely identifies the carrier that generated the error.
        carrier_code:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/carrier_code'
          description: 'The name of the shipping carrier that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.

            '
        field_name:
          type: string
          readOnly: true
          example: shipment.ship_to.phone_number
          description: The name of the field that caused the error
    register_document_response_body:
      title: register_document_response_body
      type: object
      description: 'The result of registering a document. Use the returned `upload` target to upload the document file to Amazon S3 before sending it to the carrier.

        '
      additionalProperties: false
      properties:
        document_id:
          type: string
          description: The unique identifier assigned to the registered document.
          example: 019eb24e-cd4e-7609-b740-c2324fe93272
        upload:
          allOf:
          - $ref: '#/components/schemas/document_upload_target'
          description: 'The pre-signed Amazon S3 target the document file must be uploaded to.

            '
      example:
        document_id: 019eb24e-cd4e-7609-b740-c2324fe93272
        upload:
          url: https://carrier-doc-upload.s3.amazonaws.com
          fields:
            Content-Type: application/pdf
            key: 019eb24e-cd4e-7609-b740-c2324fe93272.pdf
            x-amz-meta-document-id: 019eb24e-cd4e-7609-b740-c2324fe93272
            x-amz-meta-seller-id: '8801990'
            X-Amz-Algorithm: AWS4-HMAC-SHA256
            X-Amz-Credential: ASIA.../20260610/us-east-1/s3/aws4_request
            X-Amz-Date: 20260610T161249Z
            Policy: eyJleHBpcmF0aW9uIjoi...
            X-Amz-Signature: b81189b9df29...
            X-Amz-Security-Token: IQoJb3JpZ2lu...
    list_shipment_labels_response_body:
      title: list_shipment_labels_response_body
      type: array
      description: The list of shipments associated with the requested id and their registered documents.
      items:
        $ref: '#/components/schemas/order_shipment'
    document_upload_target:
      title: document_upload_target
      type: object
      description: 'A pre-signed Amazon S3 POST target describing where and how to upload a document file.

        '
      additionalProperties: false
      properties:
        url:
          type: string
          format: uri
          description: 'The Amazon S3 endpoint to upload the document file to via an HTTP `POST` with `multipart/form-data`.

            '
          example: https://carrier-doc-upload.s3.amazonaws.com
        fields:
          type: object
          description: 'The S3 presigned-POST form fields. Include **every** field exactly as returned in the upload request, followed by a `file` part containing the document content.

            '
          properties:
            Content-Type:
              type: string
              description: The MIME type of the document; matches the registered document format.
              example: application/pdf
            key:
              type: string
              description: The S3 object key the file will be stored under.
              example: 019eb24e-cd4e-7609-b740-c2324fe93272.pdf
            x-amz-meta-document-id:
              type: string
              description: 'S3 object metadata: the registered document''s unique identifier.'
              example: 019eb24e-cd4e-7609-b740-c2324fe93272
            x-amz-meta-seller-id:
              type: string
              description: 'S3 object metadata: the seller''s identifier.'
              example: '8801990'
            X-Amz-Algorithm:
              type: string
              description: The AWS signing algorithm used for the pre-signed POST.
              example: AWS4-HMAC-SHA256
            X-Amz-Credential:
              type: string
              description: The AWS credential scope used to sign the upload.
              example: ASIA.../20260610/us-east-1/s3/aws4_request
            X-Amz-Date:
              type: string
              description: The timestamp the signature was generated, in ISO 8601 basic format.
              example: 20260610T161249Z
            Policy:
              type: string
              description: 'The base64-encoded S3 POST policy defining the conditions the upload must satisfy, such as the allowed key, content type, size, and expiration.

                '
              example: eyJleHBpcmF0aW9uIjoi...
            X-Amz-Signature:
              type: string
              description: The signature authorizing the upload, derived from the policy and credentials.
              example: b81189b9df29...
            X-Amz-Security-Token:
              type: string
              description: The temporary AWS session token for the credentials.
              example: IQoJb3JpZ2lu...
          additionalProperties:
            type: string
    register_document_request_body:
      title: register_document_request_body
      type: object
      description: A request to register a carrier document against a shipment or label.
      additionalProperties: false
      required:
      - type
      - file_name
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/document_type'
          description: The type of document being registered.
        format:
          allOf:
          - $ref: '#/components/schemas/document_format'
          description: The file format of the document. Defaults to `PDF` when omitted.
        file_name:
          type: string
          description: The file name of the document, including its extension.
          example: usmca-certification-of-origin.pdf
    document_status_value:
      title: document_status_value
      type: string
      description: 'The processing status of a carrier document.


        - `awaiting_upload` - The document has been registered and is waiting for the file to be uploaded to the provided upload target.

        - `processing` - The uploaded file is being processed.

        - `processing_claimed` - The document has been claimed for processing.

        - `invalid` - The document failed validation and cannot be used.

        - `uploaded` - The file has been uploaded successfully and is ready to be sent to the carrier.

        - `queued` - The document is queued to be sent to the carrier.

        - `sent` - The document has been transmitted to the carrier.

        - `failed` - Sending the document to the carrier failed.

        '
      enum:
      - awaiting_upload
      - processing
      - processing_claimed
      - invalid
      - uploaded
      - queued
      - sent
      - failed
      example: awaiting_upload
    document_format:
      title: document_format
      type: string
      description: The file format of the document being uploaded.
      enum:
      - PDF
      - PNG
      example: PDF
    document_type:
      title: document_type
      type: string
      description: 'The type of carrier document being registered. Supported values vary by carrier. See the [Carrier Document Upload guide](/apis/@shipengine/docs/labels/carrier-document-upload.md) for the document types each carrier accepts.

        '
      enum:
      - commercial_invoice
      - certificate_of_origin
      - usmca_commercial_invoice_certification_of_origin
      - usmca_certification_of_origin
      - pro_forma_invoice
      - other
      - authorization_form
      - export_accompanying_document
      - export_license
      - import_permit
      - one_time_nafta
      - power_of_attorney
      - packing_list
      - sed_document
      - shippers_letter_of_instruction
      - declaration
      - section_232_customs_affidavit
      example: usmca_commercial_invoice_certification_of_origin
    send_documents_response_body:
      title: send_documents_response_body
      type: object
      description: The result of sending a label's documents to the carrier.
      additionalProperties: false
      properties:
        sent_count:
          type: integer
          description: The number of documents that were sent to the carrier.
          example: 2
        document_ids:
          type: array
          items:
            type: string
          description: The identifiers of the documents that were sent.
    order_shipment:
      title: order_shipment
      type: object
      description: A shipment associated with the requested id, along with its registered documents.
      additionalProperties: false
      properties:
        shipment_id:
          type: string
          description: The unique identifier of the shipment.
          example: se-28529731
        tracking_number:
          type: string
          description: The tracking number of the shipment.
          example: 1Z999AA10123456784
        documents:
          type: array
          description: The carrier documents registered against the shipment.
          items:
            $ref: '#/components/schemas/document_status'
    error_type:
      title: error_type
      type: string
      example: validation
      enum:
      - account_status
      - business_rules
      - validation
      - security
      - system
      - integrations
      - funding_sources
      description: 'The type of error

        '
  responses:
    404_error_response:
      description: The specified resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
    400_error_response:
      description: The request contained errors.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
    500_error_response:
      description: 'An error occurred on ShipStation API''s side.


        > This error will automatically be reported to our engineers.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
    409_error_response:
      description: The request conflicts with an existing resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
  securitySchemes:
    api_key:
      type: apiKey
      name: API-Key
      in: header
      description: 'To authenticate yourself to ShipEngine, you need to include an `API-Key` header in each API call. If you don''t include a key when making an API request, or if you use an incorrect or expired key, then ShipEngine will respond with a `401 Unauthorized` error.

        Learn more about API keys in our [authentication guide](https://docs.shipstation.com/apis/shipengine/docs/guides/auth).

        '
x-refined-from:
- shipengine-openapi-docs-bundle.yaml
- shipengine-openapi.yml