input CreateShipmentShippingLabelInput

Fields

FieldTypeDescription
carrierString!

Carrier name or carrier code used for shipping.

shipping_nameString!

Shipping name for this shipping label.

shipping_methodString!

Carrier service or shipping method code.

costString!

Internal cost as a decimal monetary amount; distinct from customer-facing price.

addressAddressInput!

Address details for this shipping label.

dimensionsDimensionsInput!

Package or item dimensions. Length, width, and height are in inches unless account or carrier configuration specifies another unit.

labelCreateLabelResourceInput!

Label associated with this shipping label.

line_item_ids[String]!

Specify the line items that should be associated with the label been created. The ids can be shipment line item ids or order line item ids (the ones used to create the shipment line items).

tracking_numberString

Carrier tracking number for the shipment or label.

tracking_urlString

URL for the tracking URL resource.

Referenced By

Example

{
  "carrier": "ups",
  "shipping_name": "UPS Ground",
  "shipping_method": "ups_ground",
  "cost": "19.99",
  "address": {address1: "123 Fulfillment Ave", city: "New York", country: "US"},
  "dimensions": {length: 12.5, width: 8.0, height: 4.0},
  "label": {tracking_number: "1Z999AA10123456784", carrier: "ups"},
  "line_item_ids": ["U2hpcG1lbnRMaW5lSXRlbToxMjM0", "U2hpcG1lbnRMaW5lSXRlbTo1Njc4"],
  "tracking_number": "1Z999AA10123456784",
  "tracking_url": "https://example.com/resource"
}