Získání stavu importu zásilky

GET

/shipment/batch/{batchId}

ShipmentBatch

Maintainer:Not configured

Význam a použití

Tato metoda vrací stav zpracování zásilky a v případě stavu "Complete" pak vrátí URL (hromadné nebo k jednotlivému balíku) pro stažení vygenerované etikety.

Aby bylo možné úspěšně zavolat metodu, je nutné použít batchId, které se získá z hlavičky Location v odpovědi na požadavek POST shipment/batch.

Request

Path Params

batchId

string <uuid>

required

batch id z metody POST shipment/batch

Query Params

OrderBy

optional

Seřaďte položky podle definovaných polí. Pro vícenásobné řazení použijte názvy polí oddělené čárkou. Použijte "-" pro sestupné pořadí (např.: OrderBy=field1,-field2).
Řaditelná pole: ShipmentNumber, ReferenceId, viz také schéma.Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.OrderBy.enum

Any of

Eps.Api.MyApi2.Web.Controllers.ShipmentBatchController.GetShipmentBatch.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/?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

completeLabel

optional

obsahuje všechny etikety založené zásilky

One of

Eps.Api.MyApi2.Web.Models.ShipmentBatch.CompleteLabelModel

EmptyNullableObject

CompleteLabelModel

labelUrls

array[string <uri>] | null

optional

LabelUrls

items

array [object {9}] | null

optional

Items

referenceId

string | null

optional

Reference Id

shipmentNumber

string | null

optional

číslo zásilky

insuranceCurrency

string | null

optional

měna pojištění

insurancePrice

number <double> | null

optional

cena pojištění

labelUrl

string <uri> | null

optional

url daného štítku

importState

enum<string>

optional

stav (complete, in process....)

Allowed values:

AcceptedInProcessCompleteError

errorMessage

string | null

optional

chybová zpráva

errorCode

string | null

optional

kód chyby

relatedItems

array [object {8}] | null

optional

přidružené položky (např. return zásilka apod.)

Examples

status200 - importState: "InProcess"status 200 - importState: "Complete"

"items": [
    {
        "referenceId": "1",
        "importState": "InProcess",
        "relatedItems": []
    }
]
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

🔴503Service Unavailable

Slouží k úpravě výstupního formátu štítku

Získání etikety

Získání stavu importu zásilky

Význam a použití#

Request

Request samples

Responses

Význam a použití