Pick up label

GET

/shipment/batch/{batchId}/label

Maintainer:Not configured

Purpose and usage

This method returns the generated label.

To successfully call the method, it is necessary to use the batchId, which is obtained from the Location header in the response to the POST shipment/batch request.

Request

Path Params

batchId

string <uuid>

required

The batch id

Query Params

PageSize

enum<string>

optional

PageSize

Allowed values:

DefaultA4

Position

integer <int32>

optional

Position

>= 1<= 4

limit

integer <int32>

required

The limit

>= 1<= 200

offset

integer <int32>

required

The offset

>= 0

OrderBy

optional

Sort items by defined fields. For multiple sorting use field names separated by comma. Use "-" to descendant order (eg.: OrderBy=field1,-field2).
Orderable fields: ShipmentNumber, ReferenceId, see also schema Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum

Any of

Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatchLabel.OrderBy.enum

string

Allowed values:

ShipmentNumberReferenceId

Header Params

Accept-Language

string

optional

Language specification, default language: cs-CZ

X-Correlation-ID

string

optional

Correlation Id of request

X-LogLevel

enum<string>

optional

The forced log level

Allowed values:

TraceDebugInformationWarningErrorCritical

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/shipment/batch//label?PageSize&Position&limit&offset&OrderBy' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;'

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

Body

string <binary>

optional

Example

"string"

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-10 14:02:14

Getting import state

Shipment cancel

Pick up label

Purpose and usage#

Request

Request samples

Responses

Purpose and usage