> ## Documentation Index
> Fetch the complete documentation index at: https://developer.orchestro.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Labels

> This endpoint allows users to create shipping labels by sending account information, parcel details, and shipment specifics. It returns the generated label or an error if the request fails.



## OpenAPI

````yaml shipper.json post /api/v1/core/labels
openapi: 3.0.3
info:
  title: Satge-e1-David-Sep13
  description: This is an Open API Spec file
  contact: {}
  version: 1.0.0
servers:
  - url: https://api-stage.orchestro.ai/e1/
    description: Sandbox Environment
  - url: https://api-stage.orchestro.ai
    description: Production Environment
security:
  - ApiKeyAuth: []
tags:
  - name: Shipper
paths:
  /api/v1/core/labels:
    post:
      tags:
        - Shipper
      summary: Labels
      description: >-
        This endpoint allows users to create shipping labels by sending account
        information, parcel details, and shipment specifics. It returns the
        generated label or an error if the request fails.
      operationId: labelRequest
      requestBody:
        description: >-
          This endpoint accepts a JSON request body that contains account
          details, caller type, currency, label format, and parcel information.
        content:
          application/json:
            schema:
              type: object
              required:
                - fulfilmentNode
              properties:
                accounts:
                  type: array
                  description: A list of accounts requesting the shipping labels.
                  example:
                    - accountNumber: AC0088
                      accountType: SHIPPER
                    - accountNumber: AC0077
                      accountType: WMS
                  items:
                    type: object
                    properties:
                      accountNumber:
                        type: string
                        description: >-
                          The unique identifier for the account requesting the
                          label.
                        example: AC0088
                      accountType:
                        type: string
                        description: The type of account, such as SHIPPER or WMS.
                        example: SHIPPER
                callerType:
                  type: string
                  description: >-
                    The type of caller initiating the request, such as SHIPPER
                    or WMS.
                  example: WMS
                currency:
                  type: string
                  description: The currency in which the transaction is carried out.
                  example: USD
                labelFormat:
                  type: string
                  description: The format of the generated label (e.g., PDF or ZPL).
                  example: PDF
                parcels:
                  type: array
                  description: >-
                    A list of parcels being shipped, including dimensions,
                    references, and other parcel-specific data.
                  items:
                    type: object
                    properties:
                      dimensions:
                        type: object
                        properties:
                          height:
                            type: number
                            description: The height of the parcel.
                            example: 12
                          length:
                            type: number
                            description: The length of the parcel.
                            example: 12
                          unit:
                            type: string
                            description: >-
                              The unit of measurement for dimensions (e.g., inch
                              or cm).
                            example: inch
                          width:
                            type: number
                            description: The width of the parcel.
                            example: 12
                        description: The dimensions of the parcel.
                      parcelType:
                        type: string
                        description: The type of parcel (e.g., P for Package).
                        example: P
                      pickupType:
                        type: string
                        description: The type of pickup (e.g., Pickup or Dropoff).
                        example: Pickup
                      reference1:
                        type: string
                        description: The first reference for tracking purposes.
                        example: '123456'
                      reference2:
                        type: string
                        description: The second reference for tracking purposes.
                        example: '123456'
                      referenceId:
                        type: string
                        description: The unique identifier for the reference.
                        example: cf6fea899f1848b494d9568e8266e076
                      serviceAttributes:
                        type: array
                        description: >-
                          Attributes associated with the service, such as
                          special handling instructions.
                        items:
                          type: string
                          description: A service attribute (e.g., AD_SIGN).
                          example: AD_SIGN
                      serviceType:
                        type: string
                        description: The type of service being requested.
                        example: DGRD
                      shipDate:
                        type: string
                        description: The date and time of shipment in ISO 8601 format.
                        example: '2023-12-22T06:34:00'
                      shipFrom:
                        type: object
                        properties:
                          address1:
                            type: string
                            description: The first line of the ship-from address.
                            example: 280 S YORK RD
                          address2:
                            type: string
                            description: The second line of the ship-from address.
                            example: ''
                          addressType:
                            type: string
                            description: The type of address.
                            example: B
                          city:
                            type: string
                            description: The city of the ship-from address.
                            example: BENSENVILLE
                          company:
                            type: string
                            description: The name of the company sending the shipment.
                            example: SHIPPERZS ATTN NAME
                          country:
                            type: string
                            description: The country of the ship-from address.
                            example: US
                          email:
                            type: string
                            description: The email address of the sender.
                            example: ''
                          name:
                            type: string
                            description: The name of the sender.
                            example: SHIPPERZS ATTN NAME
                          phone:
                            type: string
                            description: The phone number of the sender.
                            example: ''
                          state:
                            type: string
                            description: The state of the ship-from address.
                            example: IL
                          zip:
                            type: string
                            description: The postal code of the ship-from address.
                            example: '60106'
                        description: >-
                          Details of the origin address where the shipment is
                          sent from.
                      shipTo:
                        type: object
                        properties:
                          address1:
                            type: string
                            description: The first line of the ship-to address.
                            example: 637 E WOODBRIDGE AVE
                          address2:
                            type: string
                            description: The second line of the ship-to address.
                            example: ''
                          addressType:
                            type: string
                            description: The type of address.
                            example: B
                          city:
                            type: string
                            description: The city of the ship-to address.
                            example: AVENEL
                          company:
                            type: string
                            description: The name of the company receiving the shipment.
                            example: Test-Company-Name
                          country:
                            type: string
                            description: The country of the ship-to address.
                            example: US
                          email:
                            type: string
                            description: The email address of the recipient.
                            example: ''
                          name:
                            type: string
                            description: The name of the recipient.
                            example: JOSH SMITH
                          phone:
                            type: string
                            description: The phone number of the recipient.
                            example: ''
                          state:
                            type: string
                            description: The state of the ship-to address.
                            example: NJ
                          zip:
                            type: string
                            description: The postal code of the ship-to address.
                            example: '07001'
                        description: >-
                          Details of the destination address where the shipment
                          is sent.
                      weight:
                        type: object
                        properties:
                          unit:
                            type: string
                            description: The unit of measurement for the parcel weight.
                            example: lb
                          value:
                            type: number
                            description: The actual weight of the parcel.
                            example: 1
                        description: The weight of the parcel.
                sendAllServiceAttributes:
                  type: boolean
                  description: >-
                    Whether to send all service attributes related to the
                    shipment.
                  example: true
                sendTNT:
                  type: boolean
                  description: Whether to include TNT information for the shipment.
                  example: true
                shipmentDate:
                  type: string
                  description: >-
                    The date and time when the shipment is planned to be made,
                    in ISO 8601 format.
                  example: '2024-12-22T06:34:00'
                sortOrder:
                  type: string
                  description: The order in which shipment options should be sorted.
                  example: rate
                fulfilmentNode:
                  type: string
                  example: NODE123
                  description: >-
                    The identifier of the fulfilment node processing the
                    shipment.
            examples:
              LABEL Request 1 GRD:
                value:
                  callerType: SHIPPER
                  accounts:
                    - accountNumber: AC0089
                      accountType: SHIPPER
                  sendAllServiceAttributes: true
                  sendTNT: true
                  shipmentDate: '2024-12-22T06:34:00'
                  sortOrder: rate
                  transitTime: '2024-12-22T06:34:00'
                  zplEncoded: false
                  currency: USD
                  labelFormat: PNG
                  labelLayout: ''
                  fulfillmentNode: ''
                  parcels:
                    - parcelType: P
                      pickupType: Pickup
                      quoteId: 301312f9-500a-4e6a-8976-aad12db55e8c
                      reference1: testRef1
                      reference2: testRef2
                      referenceId: testRefId
                      serviceAttributes:
                        - AD_SIGN
                      serviceType: GRD
                      shipDate: '2024-08-22T06:34:00'
                      shipFrom:
                        company: Dallas City Hall
                        name: The City Secretary's Office
                        address1: 1500 Marilla Street
                        address2: ''
                        city: Dallas
                        state: TX
                        zip: '75201'
                        country: US
                        phone: ''
                        email: ''
                        addressType: B
                      shipTo:
                        company: Municipal Building
                        name: Brooklyn Municipal Building
                        address1: 210 Joralemon St
                        address2: ''
                        city: Brooklyn
                        state: NY
                        zip: '11201'
                        country: US
                        phone: 212-669-8090
                        email: ''
                        addressType: B
                      weight:
                        unit: lb
                        value: 6
                      dimensions:
                        unit: inch
                        height: 4
                        length: 4
                        width: 4
              LABEL Request 1 DGRD:
                value:
                  callerType: SHIPPER
                  labelFormat: PDF
                  accounts:
                    - accountNumber: AC0089
                      accountType: SHIPPER
                  shipmentDate: '2024-12-22T06:34:00'
                  sendTNT: true
                  sortOrder: rate
                  currency: USD
                  sendAllServiceAttributes: true
                  fulfillmentNode: ''
                  parcels:
                    - referenceId: cf6fea899f1848b494d9568e8266e076
                      reference1: 123456
                      reference2: 123456
                      shipDate: '2023-12-22T06:34:00'
                      serviceType: DGRD
                      pickupType: Pickup
                      parcelType: P
                      shipFrom:
                        company: SHIPPERZS ATTN NAME
                        name: SHIPPERZS ATTN NAME
                        address1: 280 S YORK RD
                        address2: ''
                        city: BENSENVILLE
                        state: IL
                        zip: '60106'
                        country: US
                        phone: ''
                        email: ''
                        addressType: B
                      shipTo:
                        company: Test-Company-Name
                        name: JOSH SMITH
                        address1: 637 E WOODBRIDGE AVE
                        address2: ''
                        city: AVENEL
                        state: NJ
                        zip: '07001'
                        country: US
                        phone: ''
                        email: ''
                        addressType: B
                      serviceAttributes:
                        - AD_SIGN
                      weight:
                        value: 1
                        unit: oz
                      dimensions:
                        unit: inch
                        length: 12
                        width: 12
                        height: 12
      responses:
        '200':
          description: All successful Label responses
          headers:
            Connection:
              style: simple
              explode: false
              schema:
                type: string
                example: keep-alive
            Content-Length:
              style: simple
              explode: false
              schema:
                type: string
                example: '219'
            Date:
              style: simple
              explode: false
              schema:
                type: string
                example: Tue, 17 Sep 2024 22:39:33 GMT
            Vary:
              style: simple
              explode: false
              schema:
                type: string
                example: Access-Control-Request-Headers
            Via:
              style: simple
              explode: false
              schema:
                type: string
                example: >-
                  1.1 ac8125882b03042c3557fc96ae234ffa.cloudfront.net
                  (CloudFront)
            X-Amz-Cf-Id:
              style: simple
              explode: false
              schema:
                type: string
                example: foj1gbYznZER3rI7yOK0oNvTzuvz2XTAEv-JkSzfFE5xSD70UNmjSA==
            X-Amz-Cf-Pop:
              style: simple
              explode: false
              schema:
                type: string
                example: CDG52-P3
            X-Cache:
              style: simple
              explode: false
              schema:
                type: string
                example: Miss from cloudfront
            x-amz-apigw-id:
              style: simple
              explode: false
              schema:
                type: string
                example: eRW92FmKIAMEB1A=
            x-amzn-Remapped-Connection:
              style: simple
              explode: false
              schema:
                type: string
                example: keep-alive
            x-amzn-Remapped-Content-Length:
              style: simple
              explode: false
              schema:
                type: string
                example: '219'
            x-amzn-Remapped-Date:
              style: simple
              explode: false
              schema:
                type: string
                example: Tue, 17 Sep 2024 22:39:33 GMT
            x-amzn-RequestId:
              style: simple
              explode: false
              schema:
                type: string
                example: 8588e898-5fac-414e-9ad2-072732618a3f
          content:
            application/json:
              schema:
                type: object
                properties:
                  currency:
                    type: string
                    example: USD
                  parcels:
                    type: array
                    example:
                      - dimensions:
                          height: 4
                          length: 4
                          unit: inch
                          width: 4
                        labels:
                          createdDate: 2024/09/25 09:42:32
                          id: P761NBH3
                          labelDate: 2024/09/25 09:42:32
                          labelFormat: PNG
                          labelUrl: >-
                            https://ocn-stage-e1-files.s3.amazonaws.com/P761NBH3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240925T094232Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAXLQKESR5BTU3KJX3%2F20240925%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7ff0d7c855edb5436d282468c40e82f075da4926b01608158e6937d475018b1f
                          sortCode: KEARNY
                        parcelType: P
                        pickupType: Pickup
                        quoteId: 301312f9-500a-4e6a-8976-aad12db55e8c
                        reference1: testRef1
                        reference2: testRef2
                        referenceId: testRefId
                        serviceType: GRD
                        shipDate: '2024-08-22T06:34:00'
                        shipFrom:
                          address1: 1500 Marilla Street
                          address2: ''
                          addressType: B
                          city: Dallas
                          company: Dallas City Hall
                          country: US
                          email: ''
                          name: The City Secretary's Office
                          phone: ''
                          state: TX
                          zip: '75201'
                        shipTo:
                          address1: 210 Joralemon St
                          address2: ''
                          addressType: B
                          city: Brooklyn
                          company: Municipal Building
                          country: US
                          email: ''
                          name: Brooklyn Municipal Building
                          phone: 212-669-8090
                          state: NY
                          zip: '11201'
                        weight:
                          unit: lb
                          value: 6
                    items:
                      type: object
                      properties:
                        dimensions:
                          type: object
                          properties:
                            height:
                              type: number
                              example: 4
                            length:
                              type: number
                              example: 4
                            unit:
                              type: string
                              example: inch
                            width:
                              type: number
                              example: 4
                        labels:
                          type: object
                          properties:
                            createdDate:
                              type: string
                              example: 2024/09/25 09:42:32
                            id:
                              type: string
                              example: P761NBH3
                            labelDate:
                              type: string
                              example: 2024/09/25 09:42:32
                            labelFormat:
                              type: string
                              example: PNG
                            labelUrl:
                              type: string
                              example: >-
                                https://ocn-stage-e1-files.s3.amazonaws.com/P761NBH3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240925T094232Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAXLQKESR5BTU3KJX3%2F20240925%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7ff0d7c855edb5436d282468c40e82f075da4926b01608158e6937d475018b1f
                            sortCode:
                              type: string
                              example: KEARNY
                        parcelType:
                          type: string
                          example: P
                        pickupType:
                          type: string
                          example: Pickup
                        quoteId:
                          type: string
                          example: 301312f9-500a-4e6a-8976-aad12db55e8c
                        reference1:
                          type: string
                          example: testRef1
                        reference2:
                          type: string
                          example: testRef2
                        referenceId:
                          type: string
                          example: testRefId
                        serviceType:
                          type: string
                          example: GRD
                        shipDate:
                          type: string
                          example: '2024-08-22T06:34:00'
                        shipFrom:
                          type: object
                          properties:
                            address1:
                              type: string
                              example: 1500 Marilla Street
                            address2:
                              type: string
                              example: ''
                            addressType:
                              type: string
                              example: B
                            city:
                              type: string
                              example: Dallas
                            company:
                              type: string
                              example: Dallas City Hall
                            country:
                              type: string
                              example: US
                            email:
                              type: string
                              example: ''
                            name:
                              type: string
                              example: The City Secretary's Office
                            phone:
                              type: string
                              example: ''
                            state:
                              type: string
                              example: TX
                            zip:
                              type: string
                              example: '75201'
                        shipTo:
                          type: object
                          properties:
                            address1:
                              type: string
                              example: 210 Joralemon St
                            address2:
                              type: string
                              example: ''
                            addressType:
                              type: string
                              example: B
                            city:
                              type: string
                              example: Brooklyn
                            company:
                              type: string
                              example: Municipal Building
                            country:
                              type: string
                              example: US
                            email:
                              type: string
                              example: ''
                            name:
                              type: string
                              example: Brooklyn Municipal Building
                            phone:
                              type: string
                              example: 212-669-8090
                            state:
                              type: string
                              example: NY
                            zip:
                              type: string
                              example: '11201'
                        weight:
                          type: object
                          properties:
                            unit:
                              type: string
                              example: lb
                            value:
                              type: number
                              example: 6
                  zplEncoded:
                    type: string
                    example: 'false'
              examples:
                LABEL Response 1 GRD:
                  value:
                    currency: USD
                    zplEncoded: 'false'
                    parcels:
                      - quoteId: 301312f9-500a-4e6a-8976-aad12db55e8c
                        referenceId: testRefId
                        shipDate: '2024-08-22T06:34:00'
                        serviceType: GRD
                        pickupType: Pickup
                        parcelType: P
                        shipFrom:
                          company: Dallas City Hall
                          name: The City Secretary's Office
                          address1: 1500 Marilla Street
                          address2: ''
                          city: Dallas
                          state: TX
                          zip: '75201'
                          country: US
                          phone: ''
                          email: ''
                          addressType: B
                        shipTo:
                          company: Municipal Building
                          name: Brooklyn Municipal Building
                          address1: 210 Joralemon St
                          address2: ''
                          city: Brooklyn
                          state: NY
                          zip: '11201'
                          country: US
                          phone: 212-669-8090
                          email: ''
                          addressType: B
                        weight:
                          unit: lb
                          value: 6
                        dimensions:
                          unit: inch
                          length: 4
                          width: 4
                          height: 4
                        rates:
                          - zone: 6
                            serviceType: DGRD
                            tnt: 3 - 7 days
                            baseRate: 7.06
                            totalRate: 7.41
                            totalDiscount: 1.2
                            baseRateDiscount: 0
                            surcharges:
                              - rate: 3
                                discount: 0
                                code: Pick
                                description: Pick Up Charges
                              - rate: 0.75
                                discount: 0
                                code: PEAK
                                description: Carrier Peak Surcharge
                              - rate: 2
                                discount: 0
                                code: DDAS
                                description: Delivery Area Surcharge
                              - rate: 0.29
                                discount: 0
                                code: FUEL
                                description: Fuel Surcharge
                            serviceAttributes:
                              - key: POD_RQD
                                rate: 5
                                discount: 0.1
                                available: true
                        labels:
                          id: P761NBH3
                          createdDate: 2024/09/25 09:42:32
                          labelUrl: >-
                            https://ocn-stage-e1-files.s3.amazonaws.com/P761NBH3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240925T094232Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAXLQKESR5BTU3KJX3%2F20240925%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7ff0d7c855edb5436d282468c40e82f075da4926b01608158e6937d475018b1f
                          labelDate: 2024/09/25 09:42:32
                          sortCode: KEARNY
                          labelFormat: PNG
                        reference1: testRef1
                        reference2: testRef2
                LABEL Response 1 DGRD:
                  value:
                    currency: USD
                    zplEncoded: 'false'
                    parcels:
                      - quoteId: 301312f9-500a-4e6a-8976-aad12db55e8c
                        referenceId: testRefId
                        shipDate: '2024-08-22T06:34:00'
                        serviceType: GRD
                        pickupType: Pickup
                        parcelType: P
                        shipFrom:
                          company: Dallas City Hall
                          name: The City Secretary's Office
                          address1: 1500 Marilla Street
                          address2: ''
                          city: Dallas
                          state: TX
                          zip: '75201'
                          country: US
                          phone: ''
                          email: ''
                          addressType: B
                        shipTo:
                          company: Municipal Building
                          name: Brooklyn Municipal Building
                          address1: 210 Joralemon St
                          address2: ''
                          city: Brooklyn
                          state: NY
                          zip: '11201'
                          country: US
                          phone: 212-669-8090
                          email: ''
                          addressType: B
                        weight:
                          unit: lb
                          value: 6
                        dimensions:
                          unit: inch
                          length: 4
                          width: 4
                          height: 4
                        rates:
                          - zone: 6
                            serviceType: DGRD
                            tnt: 3 - 7 days
                            baseRate: 7.06
                            totalRate: 7.41
                            totalDiscount: 1.2
                            baseRateDiscount: 0
                            surcharges:
                              - rate: 3
                                discount: 0
                                code: Pick
                                description: Pick Up Charges
                              - rate: 0.75
                                discount: 0
                                code: PEAK
                                description: Carrier Peak Surcharge
                              - rate: 2
                                discount: 0
                                code: DDAS
                                description: Delivery Area Surcharge
                              - rate: 0.29
                                discount: 0
                                code: FUEL
                                description: Fuel Surcharge
                            serviceAttributes:
                              - key: POD_RQD
                                rate: 5
                                discount: 0.1
                                available: true
                        labels:
                          id: P761NBH3
                          createdDate: 2024/09/25 09:42:32
                          labelUrl: >-
                            https://ocn-stage-e1-files.s3.amazonaws.com/P761NBH3.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240925T094232Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAXLQKESR5BTU3KJX3%2F20240925%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7ff0d7c855edb5436d282468c40e82f075da4926b01608158e6937d475018b1f
                          labelDate: 2024/09/25 09:42:32
                          sortCode: KEARNY
                          labelFormat: PNG
                        reference1: testRef1
                        reference2: testRef2
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header

````