Create label in advance

POST /openapi/Document/CreateLabelInAdvance — TMS API · Label

Performs the same operation as CreateLabel but does not return the label content, only the result message. Used to prepare the label before the packaging moment; the content can be retrieved later with GetCreatedLabel.

İstek gövdesi

  • clientCode (string, zorunlu): Organization code.
  • accountCode (string, zorunlu): Account code.
  • createLabels (object[], zorunlu): Shipments for which the label will be created.
    • createLabels.parcels (object[]): Packages to receive labels.
      • createLabels.parcels.data (any[]): Carrier-specific additional data.
      • createLabels.parcels.lines (object[]): Order lines in the package.
      • createLabels.parcels.format (string): Label format code (e.g. ZPL, PDF). If empty or unrecognized, ZPL is generated.
      • createLabels.parcels.weight (number): Package weight (kg).
      • createLabels.parcels.isFragile (boolean): Is the package fragile.
      • createLabels.parcels.isLastSequence (boolean): Is it the last package; if empty, considered true.
      • createLabels.parcels.volumetricWeight (number): Package volume.
      • createLabels.parcels.labelSequenceNumber (string): Sequence number in multi-package single label flow.
      • createLabels.parcels.customerSpecificCode (string): Package number (your unique package code).
    • createLabels.locationCode (string): Origin location code of the shipment.
    • createLabels.consignmentNumber (string): Shipment number.

Yanıtlar

  • 200: Label created; body is the label service's result message
  • 204: Label created, no result message (bodyless)
  • 400: Label creation failed
  • 401: Token missing, invalid, or expired (bodyless response).

200 yanıt alanları