Skip to content
/
Check Order Labels

Check Order Labels

Request

Retrieves the shipment label details for a specified store and order number. Applicable only to orders with a purchased shipping label.
Rate limit: 120 requests per minute.

Security
ApiTokenAuth
Query
store_namestringrequired

Store name in the ShipSaving system

order_numberstringrequired

Order number associated with the purchased label

GET
/api/shipments/get
curl -i -X GET \
  'https://api.shipsaving.com/api/shipments/get?store_name=string&order_number=string&api_token=YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
Array [
packing_slip_numberinteger

Packing slip number

Example:100108
carrierstring

Carrier's name

Example:"UPS"
predefined_packagestring

Carrier’s predefined packaging type

Example:""
service_levelstring

Carrier service type

Example:"ups_ground"
tracking_codestring

Tracking number

Example:"1ZXXXXXXXXXXXXXXXX"
lengthnumber, (float)

Package length (inch)

Example:6
widthnumber, (float)

Package width (inch)

Example:6
heightnumber, (float)

Package height (inch)

Example:6
weightnumber, (float)

Package weight (lb)

Example:1
ratenumber, (float)

Shipping rate

Example:5.99
service_feenumber, (float)

System service fee

Example:0.05
label_widthnumber, (float)

Label width (inch)

Example:4
label_heightnumber, (float)

Label height (inch)

Example:6
label_urlsArray of strings

List of image URLs for shipping labels

Example:
[
  "https://…/labels/2024-10-23/9524d5ac21a744a1954e16ebda769772_0.png"
]
commercial_invoice_urlsArray of strings

List of image URLs for commercial invoices

Example:null
]
Response
[
  {
    "packing_slip_number": 100108,
    "carrier": "UPS",
    "predefined_package": "",
    "service_level": "ups_ground",
    "tracking_code": "1ZXXXXXXXXXXXXXXXX",
    "length": 6,
    "width": 6,
    "height": 6,
    "weight": 1,
    "rate": 5.99,
    "service_fee": 0.05,
    "label_width": 4,
    "label_height": 6,
    "label_urls": [ … ],
    "commercial_invoice_urls": null
  }
]