Update a label

PUT/shipping/{connection_id}/label/{id}

Parameters

Payload

idstring

Unique identifier for this label object

created_atdate-time

The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atdate-time

The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

shipment_idstring

Reference to the shipment

tracking_numberstring

Tracking number for the shipment

label_urlstring

URL to download the label

label_format enum

Valid values:

"PDF"

"PNG"

"ZPL"

"EPL2"

"PDF_4X6"

"PDF_4X8"

"PNG_4X6"

"PNG_4X8"

Format of the label (PDF, PNG, ZPL, EPL2)

status enum

Valid values:

"PENDING"

"PROCESSING"

"IN_TRANSIT"

"DELIVERED"

"EXCEPTION"

"CANCELLED"

"LABEL_CREATED"

"PICKED_UP"

"OUT_FOR_DELIVERY"

"DELIVERY_ATTEMPTED"

"RETURNED_TO_SENDER"

"HELD_AT_LOCATION"

"CUSTOMS_CLEARANCE"

"EXCEPTION_RESOLVED"

Status of the label

is_voidedboolean

Whether label has been voided

label_costnumber

Cost to purchase label

label_cost_currencystring

rate_idstring

Rate used for this label; points to ShippingRate

service_codestring

Service code used

raw

The raw data returned by the integration for this label

Returns

ShippingLabel

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this label object
`created_at`	string (date-time)	No	The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`shipment_id`	string	No	Reference to the shipment
`tracking_number`	string	No	Tracking number for the shipment
`label_url`	string	No	URL to download the label
`label_format`	enum	No	Format of the label (PDF, PNG, ZPL, EPL2) Values: `PDF`, `PNG`, `ZPL`, `EPL2`, `PDF_4X6`, `PDF_4X8`, `PNG_4X6`, `PNG_4X8`
`status`	enum	No	Status of the label Values: `PENDING`, `PROCESSING`, `IN_TRANSIT`, `DELIVERED`, `EXCEPTION`, `CANCELLED`, `LABEL_CREATED`, `PICKED_UP`, `OUT_FOR_DELIVERY`, `DELIVERY_ATTEMPTED`, `RETURNED_TO_SENDER`, `HELD_AT_LOCATION`, `CUSTOMS_CLEARANCE`, `EXCEPTION_RESOLVED`
`is_voided`	boolean	No	Whether label has been voided
`label_cost`	number	No	Cost to purchase label
`label_cost_currency`	string	No
`rate_id`	string	No	Rate used for this label; points to ShippingRate
`service_code`	string	No	Service code used

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.shipping.updateShippingLabel({ connectionId, id, shippingLabel: { }, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'PUT',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.put(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request PUT \
  --url 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?