> ## Documentation Index
> Fetch the complete documentation index at: https://docs-nce.global-e.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get shipping documents (Merchant to Global-e)

> From the orders indicated as fulfilled, the Global-e API will return the required shipping documentation as a base64 encoded byte array and URL for printing

> [!NOTE]
>
> Part of the [Generating Shipping Documents](https://docs-nce.global-e.com/shipping-documents-api) integration guide — see it for when and how to use this endpoint.


## OpenAPI

````yaml api-reference/specs/getshippingdocuments.yaml POST /Order/GetShippingDocuments
openapi: 3.0.3
info:
  title: GetShippingDocuments
  version: 1.0.0
  description: >-
    From the orders indicated as fulfilled, the Global-e API will return the
    required shipping documentation as a base64 encoded byte array and URL for
    printing
servers:
  - url: https://{globale_api_domain}
    variables:
      globale_api_domain:
        default: globale_api_domain
        description: Global-e API host, supplied to the merchant by Global-e.
security: []
tags:
  - name: GetShippingDocuments
    x-page-title: GetShippingDocuments
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Shipping'
paths:
  /Order/GetShippingDocuments:
    post:
      tags:
        - GetShippingDocuments
      summary: Get shipping documents
      description: >-
        From the orders indicated as fulfilled, the Global-e API will return the
        required shipping documentation as a base64 encoded byte array and URL
        for printing
      operationId: getShippingDocuments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrderDispatchRequest'
            example:
              OrderId: GE123874638GB
              HubCode: hub001
              DeliveryReferenceNumber: '123756483'
              Parcels:
                - ParcelCode: '123454321'
                  Length: 37.5
                  Width: 24
                  Height: 13
                  Weight: 1300
                  ShippingAdditionalInformation:
                    - name: ITNNumber
                      value: X202487492387
                  Products:
                    - ProductCode: sku121212
                      DeliveryQuantity: 1
                      CartItemId: '1'
                      OriginCountryCode: IL
                    - ProductCode: sku131313
                      DeliveryQuantity: 2
                      CartItemId: '2'
                      OriginCountryCode: US
      responses:
        '200':
          description: >-
            Successful response, or a 200 carrying object-level processing
            errors (IsSuccess=false with the Errors array populated).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderDocumentsResponse'
              examples:
                success:
                  summary: Documents generated successfully
                  value:
                    IsSuccess: true
                    ErrorText: null
                    ShippingMethodCode: GE_DIRECT-Standard
                    Documents:
                      - DocumentTypeCode: '4'
                        DocumentTypeName: AWB
                        DocumentExtension: zpl
                        URL: >-
                          https://assets.global-e.com/documents/478D-AA72-1EB8BBDD7C27.zpl
                        DocumentData: >-
                          JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G
                      - DocumentTypeCode: '1'
                        DocumentTypeName: CommercialInvoiceAndPackingList
                        DocumentExtension: pdf
                        URL: >-
                          https://assets.global-e.com/documents/AE09-FAB014DAA421.pdf
                        DocumentData: >-
                          JVBERi0xLjUNCiW1tbW1DQoxIDAgb2[...]mDQoxNDgzNDkNCiUlRU9G
                        ErrorMessage: null
                    AdditionalRequiredDocuments: null
                    ParcelsTracking:
                      - ParcelTrackingNumber: '9895722141'
                        ParcelTrackingUrl: >-
                          https://mydhl.express.dhl/us/en/tracking.html#/results?id=9895722141
                        ParcelCode: '123454321'
                objectLevelError:
                  summary: Order could not be processed (object-level error)
                  value:
                    IsSuccess: false
                    ErrorText: >-
                      Could not retrieve documents and/or process order. Either
                      order is in wrong status (Cancelled) or partial
                      information provided.
                    Documents: null
                    ParcelsTracking: null
                    TrackingDetails: null
                    Errors:
                      - OrderID: GE3008553US
                        ErrorCode: A200
                        ErrorText: >-
                          Could not retrieve documents and/or process order.
                          Either order is in wrong status (Cancelled) or partial
                          information provided.
                        MerchantOrderID: null
        '400':
          description: >-
            General API error (e.g. invalid request). Returned for request-level
            failures — the call itself could not be accepted. Errors affecting
            an individual order are returned on the 200 instead, in the `Errors`
            array (see `ErrorCode` for the full code list).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
              examples:
                missingField:
                  summary: A required field was empty or null
                  value:
                    Code: EmptyString
                    Error: >-
                      Parameter Parcel(PROBE-826842939-D).Products.ProductCode
                      was empty or null
                    Description: >-
                      Please provide a valid value for the
                      Parcel(PROBE-826842939-D).Products.ProductCode parameter
                    Success: false
                noIdentifier:
                  summary: No order identifier supplied
                  value:
                    Code: '400'
                    Error: MerchantOrderId is missing
                    Description: >-
                      Please provide valid values for OrderId, MerchantOrderId
                      parameters
                    Success: false
                unknownOrder:
                  summary: The identifier did not match an order
                  value:
                    Code: '400'
                    Error: Invalid orderId
                    Description: Order 12345 could not be found
                    Success: false
        '500':
          description: General API error (server error).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
              example:
                Code: A500
                Error: SMB API returns an error
                Description: >-
                  There was an error generating a label via the Global-e SMB
                  Bridge.
components:
  schemas:
    UpdateOrderDispatchRequest:
      type: object
      title: UpdateOrderDispatchRequest
      required:
        - OrderId
        - Parcels
      properties:
        OrderId:
          type: string
          description: >-
            "eCommerce order number" as passed down in the order payload. For
            Shopify, should be either the Shopify Order Name (default), e.g.
            #12345; or the Shopify Order Number, e.g. 12345. The Global-e order
            ID is also accepted.
        DeliveryReferenceNumber:
          type: string
          description: Additional informative dispatch reference.
        HubCode:
          type: string
          description: >-
            When dispatching from multiple hubs, indicates for a given call
            which hub the related shipment will be dispatched from.
        IsCompleted:
          type: boolean
          description: >-
            When `true`, all items not already declared as part of a parcel will
            be cancelled and refunded. Until `true`, consolidation of parcels is
            expected.
        Parcels:
          type: array
          description: >-
            List of parcels being shipped. May be an empty array: a request with
            no parcels returns the order's existing shipping documents.
          items:
            $ref: '#/components/schemas/ParcelProductInformation'
        TrackingDetails:
          allOf:
            - $ref: '#/components/schemas/TrackingDetails'
          nullable: true
          description: >-
            Order-level tracking information. Add tracking on each parcel or for
            the entire order, not both.
    OrderDocumentsResponse:
      type: object
      title: OrderDocumentsResponse
      properties:
        IsSuccess:
          type: boolean
          description: Indicates whether the API call was successful.
        ErrorText:
          type: string
          nullable: true
          description: Description of the error for getting documents.
        ShippingMethodCode:
          type: string
          nullable: true
          description: >-
            The merchant-configured shipping method code for the order's
            selected shipping method — the same value carried in
            `InternationalDetails.ShippingMethodCode` on Global-e's outbound
            order flows. This is the configured code, NOT the service level.
            Returned as `null` when no code can be resolved for the order's
            shipping method.
          example: GE_DIRECT-Standard
        Documents:
          type: array
          nullable: true
          description: List of OrderDocument objects that hold the shipping documents.
          items:
            $ref: '#/components/schemas/OrderDocument'
        ParcelsTracking:
          type: array
          nullable: true
          description: >-
            The list of Merchant.ParcelTracking objects. Each object holds the
            parcel tracking number and the full tracking URL of the relevant
            shipper (with the parcel tracking number).
          items:
            $ref: '#/components/schemas/ParcelTracking'
        TrackingDetails:
          allOf:
            - $ref: '#/components/schemas/MerchantTrackingDetails'
          nullable: true
          description: Order tracking information.
        DeliveryAdviceInformation:
          type: array
          nullable: true
          description: >-
            List of DeliveryAdviceInformation objects that hold the information
            required for the "Delivery Advice" document.
          items:
            $ref: '#/components/schemas/DeliveryAdviceInformation'
        AdditionalRequiredDocuments:
          type: array
          nullable: true
          description: >-
            Additional shipping documents the order requires, such as an Export
            Accompanying Document (EAD). This array flags what is needed; the
            documents themselves arrive via
            SendAdditionalRequiredDocumentsToMerchant. See the Export documents
            guide.
          items:
            $ref: '#/components/schemas/AdditionalRequiredDocument'
        Errors:
          type: array
          nullable: true
          description: Object-level processing errors (returned with HTTP 200).
          items:
            $ref: '#/components/schemas/OrderError'
    ErrorInfo:
      type: object
      title: ErrorInfo
      description: >-
        A request-level failure. The call itself was not accepted, so no order
        was processed. Shape verified against live QA responses on 2026-09-21.
      properties:
        Code:
          type: string
          description: >-
            Error code. Not a fixed vocabulary — observed values include a
            symbolic name (`EmptyString`) and the HTTP status as a string
            (`400`) for the same class of failure. Do not branch on this value;
            read `Error` instead.
        Error:
          type: string
          description: >-
            Error message, naming the offending parameter and its position — for
            example `Parameter Parcel(P1).Products.ProductCode was empty or
            null`.
        Description:
          type: string
          description: Error description.
        Success:
          type: boolean
          description: Always `false` on an error response.
    ParcelProductInformation:
      type: object
      title: ParcelProductInformation
      required:
        - ParcelCode
        - Products
      properties:
        ParcelCode:
          type: string
          maxLength: 20
          description: >-
            Unique identifier for each parcel (/package) to be shipped. Can be
            freely generated in any range as long as it is unique and no longer
            than 20 characters.
        Products:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        ShippingAdditionalInformation:
          type: array
          description: >-
            Details about additional shipping information. If a shipment
            contains one or multiple items with the exact same HS code, the
            merchant can use this parameter to provide additional information.
          items:
            $ref: '#/components/schemas/ShippingAdditionalInformationParameter'
        TrackingDetails:
          allOf:
            - $ref: '#/components/schemas/TrackingDetails'
          nullable: true
          description: >-
            Tracking information for this parcel — when the AWB has been
            generated through other means outside Global‑e.
        Weight:
          type: number
          description: >-
            Total weight of the parcel, in grams. Sent on to DHL and Aramex on
            the ship request. Global‑e divides it across the products in the
            parcel by simple average — a 1000 g parcel holding two items gives
            each item 500 g. If not specified, the value is taken from the
            default provided in the product catalogue.
        Length:
          type: number
          description: >-
            Length of the parcel, in centimetres. Sent on to DHL and Aramex on
            the ship request. For Aramex, Global‑e uses the first parcel's
            dimensions for the whole shipment, including consolidated shipments.
            If not specified, the value is taken from the default provided in
            the product catalogue.
        Width:
          type: number
          description: Width of the parcel, in centimetres. Same handling as `Length`.
        Height:
          type: number
          description: Height of the parcel, in centimetres. Same handling as `Length`.
    TrackingDetails:
      type: object
      title: TrackingDetails
      properties:
        TrackingNumber:
          type: string
          description: Parcel tracking number.
        TrackingURL:
          type: string
          description: Tracking URL for the shipment.
        ShipperName:
          type: string
          description: Name of the carrier.
    OrderDocument:
      type: object
      title: OrderDocument
      properties:
        DocumentData:
          type: string
          description: Base64 encoded byte array representing the document file content.
        URL:
          type: string
          format: uri
          description: URL of the document.
        DocumentTypeCode:
          type: string
          description: >-
            Document type code. (Note: for PLT countries the commercial invoice
            is not returned in the response.) This value can be:
            CommercialInvoice = 1, PackingList = 2, ShipperManifest = 3, Label =
            4, VATInvoice = 5, DangerousGoodDeclarationLink = 6, GELabel = 7,
            CustomerReceiptInvoice = 8, ArchiveLabel = 9, DeliveryAdvice = 10.
          enum:
            - '1'
            - '2'
            - '3'
            - '4'
            - '5'
            - '6'
            - '7'
            - '8'
            - '9'
            - '10'
        DocumentTypeName:
          type: string
          description: >-
            Document type name such as AWB, CommercialInvoiceAndPackingList or
            Manifest.
        DocumentExtension:
          type: string
          description: Document extension (pdf, zpl, epl).
        ErrorMessage:
          type: string
          nullable: true
          description: >-
            Description of the error for this entity (order/parcel) if it
            happened.
        ParcelCode:
          type: string
          description: The parcel code related to the document.
    ParcelTracking:
      type: object
      title: Merchant.ParcelTracking
      properties:
        ParcelTrackingNumber:
          type: string
          description: >-
            The tracking number used by the selected international shipping
            method for this parcel.
        ParcelTrackingUrl:
          type: string
          format: uri
          description: >-
            Full tracking URL including ParcelTrackingNumber used by the
            selected international shipping method for this parcel.
        ParcelCode:
          type: string
          description: Parcel code.
    MerchantTrackingDetails:
      type: object
      title: Merchant.TrackingDetails
      properties:
        TrackingNumber:
          type: string
          description: The tracking number as the shipper has specified.
        ShipperName:
          type: string
          description: The shipping method name.
        TrackingURL:
          type: string
          format: uri
          description: >-
            Full tracking URL including the TrackingNumber used by the selected
            international shipping method.
    DeliveryAdviceInformation:
      type: object
      title: DeliveryAdviceInformation
      properties:
        ParcelCode:
          type: string
          description: Parcel code.
        CommercialInvoiceNumber:
          type: string
          nullable: true
          description: >-
            Commercial invoice number of the parcel if it exists on the parcel
            level, otherwise order commercial invoice number. Can be null if a
            commercial invoice does not exist for the order.
        TotalValue:
          type: number
          format: float
          description: Value of all products in the parcel.
        CurrencyCode:
          type: string
          description: TotalValue 3-char ISO currency code.
    AdditionalRequiredDocument:
      type: object
      title: AdditionalRequiredDocument
      properties:
        DocumentTypeCode:
          type: string
          description: >-
            Document type code of the required document. For example, `11` = EAD
            (Export Accompanying Document).
          example: '11'
        DocumentTypeName:
          type: string
          description: Document type name of the required document.
          example: EAD
    OrderError:
      type: object
      title: OrderError
      properties:
        OrderID:
          type: string
          description: Order identifier.
        ErrorCode:
          type: string
          example: A200
          description: >-
            Object-level error code. One of the documented GetShippingDocuments
            codes:


            | Code | Error text in response | When it occurs |

            | --- | --- | --- |

            | `A100` | Invalid information schema. | Technical errors — for
            example, a wrong JSON object structure. |

            | `A200` | Could not retrieve documents and/or process orders.
            Either the order has the wrong status or partial information is
            provided. | Logical errors — for example, the order has the wrong
            status. |

            | `A300` | There is at least one SKU that was not part of the
            original order. Please use only SKUs which were originally ordered.
            | The fulfilled SKUs contain a SKU that was not originally ordered
            (and SKU validation is turned on). |

            | `A400` | Either there are no valid SKUs to place in parcels or
            parcels could not be created. | ALL fulfilled SKUs were not
            originally ordered, so amending would leave no item to put in
            parcels (and SKU validation is turned off). |

            | `A500` | SMB API returns an error | An error occurred generating a
            label via the Global-e SMB Bridge. |

            | `A018` | Failed to generate an AWB with {shipper name} | A ship
            request fails. |

            | `A019` | The order was and cannot be shipped | The order is in
            ‘Cancelled’ status. |
        ErrorText:
          type: string
          description: Error text in response.
        MerchantOrderID:
          type: string
          nullable: true
          description: Merchant order identifier; may be null.
    Product:
      type: object
      title: Product
      required:
        - ProductCode
        - DeliveryQuantity
      properties:
        ProductCode:
          type: string
          description: >-
            Product reference from the merchant as available in the eCommerce
            platform. For Shopify, should be either the Shopify SKU or Barcode
            for the product to be shipped.
        DeliveryQuantity:
          type: integer
          description: Quantity of a product to be shipped.
        CartItemId:
          type: string
          description: >-
            Identifier of the specific order line this entry refers to, as
            supplied when the order was created. Optional. Include it when an
            order carries more than one line with the same `ProductCode` —
            without it there is no way to indicate which of those lines is being
            shipped. The value must match a line on the order.
        OriginCountryCode:
          type: string
          description: >-
            Country of origin of the product, as a 2-character ISO country code.
            Sent on to DHL and Aramex on the ship request. If not specified, the
            value is taken from the default provided in the product catalogue as
            part of the ecommerce integration.
    ShippingAdditionalInformationParameter:
      type: object
      title: ShippingAdditionalInformationParameter
      properties:
        name:
          type: string
          description: Name of additional information item, for example ITNNumber.
        value:
          type: string
          description: Value of additional information item.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.