Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Transactions

Create a shipping label

Creates a new transaction object and purchases the shipping label using a rate object that has previously been created.

Alternatively, creates a new transaction object and purchases the shipping label instantly using shipment details, an existing carrier account, and an existing service level token.

post/transactions

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Request body

OR

Example request

{
  "label_file_type": "PDF_4x6",
  "metadata": "Order ID #12345",
  "rate": "ec9f0d3adc9441449c85d315f0997fd5",
  "order": "adcfdddf8ec64b84ad22772bce3ea37a"
}

Response

Created transaction

commercial_invoice_urlstring

A URL pointing to the commercial invoice as a 8.5x11 inch PDF file. A value will only be returned if the Transactions has been processed successfully and if the shipment is international.

etastring

The estimated time of arrival according to the carrier.

label_file_type'PNG' | 'PNG_2.3x7.5' | 'PDF' | 'PDF_2.3x7.5' | 'PDF_4x6' | 'PDF_4x8' | 'PDF_A4' | 'PDF_A5' | 'PDF_A6' | 'ZPLII'

Print format of the label. If empty, will use the default format set from the Shippo dashboard.

label_urlstring

A URL pointing directly to the label in the format you've set in your settings. A value will only be returned if the Transactions has been processed successfully.

metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

object_createdstring date-time

Date and time of Transaction creation.

object_idstring

Unique identifier of the given Transaction object.

object_ownerstring

Username of the user who created the Transaction object.

object_state'VALID' | 'INVALID'

Indicates the validity of the enclosing object

object_updatedstring date-time

Date and time of last Transaction update.

parcelstring

Object ID of the Parcel object that is being shipped.

qr_code_urlstring

A URL pointing directly to the QR code in PNG format. A value will only be returned if requested using qr_code_requested flag and the carrier provides such an option.

status'WAITING' | 'QUEUED' | 'SUCCESS' | 'ERROR' | 'REFUNDED' | 'REFUNDPENDING' | 'REFUNDREJECTED'

Indicates the status of the Transaction.

testboolean

Indicates whether the object has been created in test mode.

tracking_numberstring

The carrier-specific tracking number that can be used to track the Shipment. A value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully.

tracking_status'UNKNOWN' | 'PRE_TRANSIT' | 'TRANSIT' | 'DELIVERED' | 'RETURNED' | 'FAILURE'

Indicates the high level status of the shipment.

tracking_url_providerstring

A link to track this item on the carrier-provided tracking website. A value will only be returned if tracking is available and the carrier provides such a service.

Example response

{
  "created_by": {
    "first_name": "Shwan",
    "last_name": "Ippotle",
    "username": "shippotle@shippo.com"
  },
  "label_file_type": "PDF_4x6",
  "label_url": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
  "messages": [
    {
      "source": "UPS",
      "code": "carrier_timeout",
      "text": "UPS API did not respond. Please try again in a few minutes."
    }
  ],
  "object_id": "915d94940ea54c3a80cbfa328722f5a1",
  "object_owner": "shippotle@shippo.com",
  "parcel": "e94c7fdfdc7b495dbb390a28d929d90a",
  "qr_code_url": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA",
  "rate": {
    "amount": "5.5",
    "amount_local": "5.5",
    "currency": "USD",
    "currency_local": "USD",
    "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
    "provider": "USPS",
    "carrier_account": "078870331023437cb917f5187429b093",
    "servicelevel_name": "Priority Mail",
    "servicelevel_token": "fedex_ground"
  },
  "status": "SUCCESS",
  "tracking_number": "9499907123456123456781",
  "tracking_status": "DELIVERED",
  "tracking_url_provider": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781"
}