Ship

Request a shipping label

post/ship

Request

  • Base URL: https://api-stg.passportshipping.com/v3
  • URL: https://api-stg.passportshipping.com/v3/ship
  • Auth: none declared

Request body

referencestring

The ID you are using for identifying the order for who you are requesting the rate, optional but strongly encouraged

contents_type'merchandise' | 'documents' | 'gift' | 'goods' | 'other' | 'returned_goods' | 'returnedgoods' | 'sample'

Indication of the goods classification for customs

label_image_format'png' | 'zpl' | 'pdf'
service_name'StandardDdu' | 'StandardDduDelcon' | 'PriorityDdu' | 'PriorityDduDelcon' | 'PriorityDdp' | 'PriorityDdpDelcon' | 'epacketDdp' | 'ExpressDdp' | 'GlobalPlus' | 'ExpeditedDdpDelcon' | 'ExpressDdpDelcon' | 'ExpeditedDduDelcon' | 'ExpressDduDelcon' required

Example request

{
  "address_to": {
    "reference": "To address 1",
    "street1": "111 Broadway Ave.",
    "street2": "Floor 7",
    "city": "London",
    "zip": "B33 8TH",
    "country": "GB",
    "name": "John Smith",
    "company": "Company Inc",
    "phone": "518-111-1111",
    "email": "js-myth@example.com",
    "customer_tax_id": "CHE-123.456.789 HR",
    "pudo_id": "PUDO-123456"
  },
  "address_from": {
    "reference": "From address 1",
    "street1": "111 sunset blvd.",
    "city": "Los angeles",
    "state": "CA",
    "zip": "90111",
    "country": "US",
    "name": "Allison Fox",
    "company": "ProShip",
    "phone": "518-111-1111",
    "email": "js-myth@example.com"
  },
  "parcel": {
    "reference": "Parcel ID",
    "length": 10.5,
    "units_length": "in",
    "width": 5.2,
    "height": 1.1,
    "weight": 100.15,
    "units_weight": "oz"
  },
  "items": [
    {
      "description": "Blackt T-shirt",
      "hs_code": "3304300000",
      "sku": "GEN12345",
      "non_standard_manufacturer_product_id": "MFR-SKU-12345",
      "standard_manufacturer_product_id": "0012345678905",
      "quantity": 2,
      "value": 12.34,
      "weight": 0.5,
      "units_weight": "oz",
      "origin": "US",
      "currency": "USD"
    }
  ],
  "service_name": "PriorityDdpDelcon"
}

Response

(OK) List of available rates for given shipment params

codenumber
ratenumber
dutynumber
taxnumber
insurancenumber

0 or NULL if no insurance

currencystring

Accepted values are three-letter ISO 4217 codes

labelstring

Link to the amazon S3 bucket with the file

tracking_urlstring

Example response

{
  "rate": 18.62,
  "tax": 2.47,
  "insurance": 1.3,
  "currency": "USD",
  "label": "https://s3-us-west-2.amazonaws.com/stg-postage-label/20180731/b64515eaf3a7a7729dc40fc07d1e88dc1532985659248.png",
  "tracking_url": "https://track-stg.passportshipping.com/PG3450126846CA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.