Skip to main content

Generate Label

POST 
https://api.goodsdelivery.io/v1/label

Authorization: x-api-key

name: x-api-keytype: apiKeyscopes: brandin: header

Use this endpoint to generate a shipping label for a specific delivery or return using the ID.

While labels are not required by default, they are expected. However, when creating deliveries and returns, you may add "WITHOUT_LABEL" as an add-on to indicate that the delivery will not have a label.

The endpoint currently only supports the following formats and sizes:

  • Format: pdf or html
  • Size:
    • Width: 4 inches
    • Height: 6 inches

If you prefer a different size or format, please don’t hesitate to reach out to us at niels.thomsen@goodsdelivery.io. We're happy to add additional options upon request.

Request​

Body

required
    jobId string

    ID or Short ID of delivery or return

    externalId string

    External ID of delivery or return

    brandId string

    Unique identifier of the brand

    format string

    Possible values: [pdf, html]

    labelSize object
    width number

    Possible values: >= 4 and <= 10

    height number

    Possible values: >= 5 and <= 10

Responses​

If the request is valid, a successful response will contain the requested shipping label.

If the request is invalid, the error response will include an error code and a helpful error message, such as, "The requested delivery does not exist.”

Schema
  • string binary
curl -L -X POST 'https://api.goodsdelivery.io/v1/label' \
-H 'Content-Type: application/json' \
-H 'Accept: application/pdf' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "jobId": "string",
  "externalId": "string",
  "brandId": "string",
  "format": "pdf",
  "labelSize": {
    "width": 0,
    "height": 0
  }
}'
Request Collapse all
Base URL
https://api.goodsdelivery.io/v1
Auth
Body required
{

  "jobId": "string",

  "externalId": "string",

  "brandId": "string",

  "format": "pdf",

  "labelSize": {

    "width": 0,

    "height": 0

  }

}
ResponseClear

Click the Send API Request button above and see the response here!