CPL API
Užitečné odkazy
  • Developer
  • Sandbox
Užitečné odkazy
  • Developer
  • Sandbox
Switch to english
  1. ShipmentBatch
  • Back to home
  • API Metody
  • AccessPoint
    • Seznam výdejních míst
  • AddressWhisper
    • Našeptávač adres
  • Codelist
    • Číselník pro službu kontroly věku příjemce
    • Číselník produktů
    • Číselník typů externích čísel
    • Číselník zemí + povolení COD
    • Číselník povolených měn
    • Metoda pro získání poskytovaných služeb k zásilkám.
    • Metoda pro získání minimálních a maximálních hodnot u služeb
    • Fáze zásilky
    • Statusy zásilky /shipment
    • Chybové hlášení
    • Typy osobních dokladů
  • Customer
    • Informace k zákazníkovi – povolené měny
    • Zákazníkovy adresy
  • Info
    • info
  • Order
    • Získání informace o objednávce přepravy
  • OrderBatch
    • Slouží k vytvoření objednávky. Odpověď je v header (Location)
    • Získaní stavu objednávky
  • OrderEvent
    • Zrušení objednání svozu nebo balíku z libovolné adresy
  • Shipment
    • Slouží k získání informací (trackingu) k zásilce
  • ShipmentBatch
    • Vytvoření zásilky
      POST
    • Slouží k úpravě výstupního formátu štítku
      PUT
    • Získání stavu importu zásilky
      GET
    • Získání etikety
      GET
  • ShipmentEvent
    • storno zásilky
    • úprava kontaktu
  • VersionInformation
    • informace o novinkách
  1. ShipmentBatch

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
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
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
"items": [
    {
        "referenceId": "1",
        "importState": "InProcess",
        "relatedItems": []
    }
]
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
🔴503Service Unavailable
Modified at 2025-02-05 08:29:55
Previous
Slouží k úpravě výstupního formátu štítku
Next
Získání etikety
Built with