Generate Labels

POST /orders/generate-labels

Generate labels for a list of orders

application/json

Body

  • orders array Required

    The array of order UUIDs

  • size string Required

    The shipping label size.

    Values are A4, A5, A6, PAPER_ROLL, or TAG.

Responses

  • 200

    Generated.

    Hide response attributes Show response attributes object
    • message string
    • data object
      Hide data attribute Show data attribute
      • url string

        The url of the generated labels.

POST /orders/generate-labels
curl \
 -X POST https://{workspace}.fleetrunnr.com/api/v1/orders/generate-labels \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"orders":["8eb8168d-07e3-4bf9-a678-636689d1a876"],"size":"A6"}'
Request example
{
  "orders": [
    "8eb8168d-07e3-4bf9-a678-636689d1a876"
  ],
  "size": "A6"
}
Response examples (200)
{
  "message": "success",
  "data": {
    "url": "https://s3.eu-west-1.amazonaws.com/media.fleetrunnr/6e92736d-7f41-46de-9c72-6c8b74990722.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3GLSPZCROCOCUP7S%2F20220401%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220401T094455Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=51eda1ef262f8a0e21786814735a6144e6e157b867250892182fcbf0f04ca414"
  }
}