Skip to content

Get a shipment label

GET
/stores/{storeRef}/orders/{id}/shipments/{shipmentId}/label
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/orders/1/shipments/1/label \
--header 'x-api-key: <x-api-key>'

Returns a short-lived URL of the shipment’s waybill PDF, fetched from the AllinGo carrier on each call, to print and attach to the parcel. The label can be unavailable for a short time after booking. This route needs the write:orders scope.

Required scopes: write:orders

id
required
integer

The order ID.

shipmentId
required
integer

The shipment ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
url
required

URL of the waybill PDF.

string
expires_at
required

When the URL stops working, as an ISO 8601 timestamp, or null when it is not reported.

string
nullable

Example generated

{
"url": "example",
"expires_at": "example"
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The request conflicts with the resource’s current state.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}