Used to modify the output format of the label.

PUT

/shipment/batch/{batchId}

ShipmentBatch

Maintainer:Not configured

Purpose and usage

This method allows changing the label format by providing a modified labelSettings or returnChannel body from the shipment/batch method.

Request

Path Params

batchId

string <uuid>

required

The batch id

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

Body Params application/json

UpdateShipmentBatchModel

returnChannel

optional

One of

Eps.Api.MyApi2.Web.Models.ShipmentBatch.ReturnChannelModel

EmptyNullableObject

ReturnChannelModel

type

optional

address

string | null

optional

Pokud je vybrán Type = Email, pak zde vyplňovat email příjemce etikety Délka: 100

<= 100 characters

labelSettings

object (Eps.Api.MyApi2.Web.Models.ShipmentBatch.LabelSettingsModel)

required

LabelSettingsModel

format

enum<string>

optional

Label format

Allowed values:

ZplPdfJpegPngSvg

dpi

integer <int32> | null

optional

Volba DPI pro ZPL

>= 203<= 1200

completeLabelSettings

optional

Example

{
    "labelSettings": {
        "format": "Pdf",
        "completeLabelSettings": {
            "isCompleteLabelRequested": true,
            "pageSize": "A4"
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/shipment/batch/' \
--header 'Accept-Language;' \
--header 'X-Correlation-ID;' \
--header 'X-LogLevel;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "labelSettings": {
        "format": "Pdf",
        "completeLabelSettings": {
            "isCompleteLabelRequested": true,
            "pageSize": "A4"
        }
    }
}'

Responses

🟢204No Content

application/json

No Content

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

Body

object {0}

Example

{}

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-02-10 09:33:53

Shipment creation

Getting import state

Used to modify the output format of the label.

Purpose and usage#

Request

Request samples

Responses

Purpose and usage