Číselník typů externích čísel

Význam a použití

Metoda slouží k získávání seznamů kódů a názvů, které se v CPL API používají k identifikaci externích čísel. externalNumbers jsou externí čísla pro zákaznické identifikace. Např. číslo objednávky, nebo třeba nějaký kód zboží. Nejčastěji se používá code CUST jako zákaznické. Toto číslo se následně tiskne i přímo na etiketu a zároveň se propisuje zákazníkovi do fakturace. Využití najde především jako:

Externí reference

V logistických procesech je běžné, že odesilatel či e-shop pracuje s vlastními identifikátory (např. číslo objednávky, číslo faktury, číslo klienta atd.).

PPL pak může potřebovat uvést, k jakému typu externího čísla se zadaný údaj vztahuje.

codelist/externalNumbers tedy poskytuje podporované kódy pro tyto typy číselných či alfanumerických referencí, aby bylo jasné, jak je v systému správně evidovat.

Propojení se systémy

Pokud existuje více různých typů čísel/ID, PPL chce vědět, které z nich e-shop/odesilatel poskytuje.

Tím pádem lze zvolit správný code při vytváření záznamu o zásilce.

Request

Query Params

Limit

integer <int32>

required

>= 1<= 1000

Offset

integer <int32>

required

>= 0

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

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

X-Paging-Total-Items-Count

string

optional

Total items in result

X-Paging-Offset

string

optional

Paging offset

X-Paging-Limit

string

optional

Page size

Body

array of:

code

string | null

optional

interní kód externího čísla (krátký identifikátor používaný při objednávce, ve formulářích, v API)

name

string | null

optional

čitelný text (popis druhu externího čísla)

allowInput

boolean

optional

AllowInput

Example

[
    {
        "code": "string",
        "name": "string",
        "allowInput": true
    }
]

🟠400Bad Request

🔴500Server Error

🔴503Service Unavailable

Číselník typů externích čísel

Význam a použití#

Request

Request samples

Responses

Význam a použití