B2B-EXOService-Callback is used for definition of callbacks of consignment's events for external partner.
The URL and authorization of Service (description of methods and resources included) of external partner must be accepted of Czech post (AICT department of CP).
version: 1.0.2
Tags:
For get information about event "instock" (for handover to the customer) it is necessary to define URL endpoint with the POST method.
Request body:
{
"externalConsignmentID": "abcd-123456",
"dateEvent": "2022-02-16T10:48:11+01:00",
"placeEvent": "10008",
"productId": "Ext_01_123",
"masterConsignmentId": "ABC1234"
}
Schema description:
schemas:
Instock:
type: object
required:
- externalConsignmentID
- dateEvent
- placeEvent
- productId
properties:
externalConsignmentID:
type: string
minLength: 1
maxLength: 36
description: Unique external ID of the consignment. / Jednoznačné externí ID zásilky.
example: 'abcd-123456'
dateEvent:
type: string
format: datetime
description: Datetime in format ISO8601. / Datumočas ve formátu ISO8601.
example: '2022-02-16T10:48:11+01:00'
placeEvent:
type: string
description: Zip code of branch./ PSČ provozovny ČP.
example: '10008'
productId:
type: string
maxLength: 20
description: External partner product identification. / Označení (identifikace) produktu externího partenera.
example: 'Ext_01_123'
masterConsignmentId:
type: string
minLength: 1
maxLength: 36
description: Unique external ID of the master consignment in case of multi-piece consignment. / Jednoznačné externí ID hlavní zásilky v případě vícekusé zásilky.
example: 'abcd-123400'
description: Properties of Instock status (use for stored for the customer). / Vlastnosti stavu Naskladněno (použití při uložení pro výdej zákazníkovi).
For get information about event "handover" (to the customer) it is necessary to define URL endpoint with the POST method.
Request body:
{
"externalConsignmentID": "abcd-123456",
"dateEvent": "2022-02-16T10:48:11+01:00",
"placeEvent": "10008",
"verificationType": "PickupCode",
"paymentType": "CASH",
"firstName": "Karel",
"surname": "Novák",
"personalIDType": "Občanský průkaz",
"personalID": "45678"
}
Schema description:
schemas:
HandoverRequestBody:
type: object
required:
- externalConsignmentID
- dateEvent
- placeEvent
- verificationType
properties:
externalConsignmentID:
type: string
minLength: 1
maxLength: 36
description: Unique external ID of the consignment. / Jednoznačné externí ID zásilky.
example: 'abcd-123456'
dateEvent:
type: string
format: datetime
description: Datetime in format ISO8601. / Datumočas ve formátu ISO8601.
example: '2022-02-16T10:48:11+01:00'
placeEvent:
type: string
description: Zip code of branch./ PSČ provozovny ČP.
example: '10008'
verificationType:
type: string
enum:
- PickupCode
- ID
description: Type of verification - by using PickupCode, by identification by ID. / Typ vydání - použitím kódu pro výdej, na osobní doklad.
paymentType:
type: string
enum:
- CASH
- CARD
description: Type of payment of the COD. / Typ úhrady dobírky.
firstName:
type: string
description: First name of the person whom was handed over the consignment. / Křestní jméno osoby, které byla zásilka předána.
example: "Karel"
surname:
type: string
description: Surname of the person whom was handed over the consignment. / Příjmení osoby, které byla zásilka předána.
example: "Novák"
personalIDType:
type: string
description: Type of personal ID. / Typ osobního dokladu.
example: 'Občanský průkaz'
personalID:
type: string
description: Last 5 characters of the ID of person whom was handed over the consignment. / Posledních 5 znaků z dokladu osoby, které byla zásilka předána.
example: '45678'
For get information about event "outstock" (return the consignment to the external partner courier) it is necessary to define URL endpoint with the POST method.
Request body:
{
"externalConsignmentID": "abcd-123456",
"dateEvent": "2022-02-16T10:48:11+01:00",
"placeEvent": "10008"
}
Schema description:
schemas:
Outstock:
type: object
required:
- externalConsignmentID
- dateEvent
- placeEvent
properties:
externalConsignmentID:
type: string
minLength: 1
maxLength: 36
description: Unique external ID of the consignment. / Jednoznačné externí ID zásilky.
example: 'abcd-123456'
dateEvent:
type: string
format: datetime
description: Datetime in format ISO8601. / Datumočas ve formátu ISO8601.
example: '2022-02-16T10:48:11+01:00'
placeEvent:
type: string
description: Zip code of branch./ PSČ provozovny ČP.
example: '10008'
description: Detail of outstock status (to the external partner). / Detail stavu vydáno (kurýrovi ext.partnera).
For request for extraordinary event "outstock" (for case - necessary return the consignment to the external partner before deposite TO date) it is necessary to define URL endpoint with the POST method.
Request body:
{
"externalConsignmentID": "abcd-123456",
"dateEvent": "2022-02-16T10:48:11+01:00",
"placeEvent": "10008"
}
Schema description:
OutstockRequest:
type: object
required:
- externalConsignmentID
- dateEvent
- placeEvent
properties:
externalConsignmentID:
type: string
minLength: 1
maxLength: 36
description: Unique external ID of the consignment. / Jednoznačné externí ID zásilky.
example: 'abcd-123456'
dateEvent:
type: string
format: datetime
description: Datetime in format ISO8601. / Datumočas ve formátu ISO8601.
example: '2022-02-16T10:48:11+01:00'
placeEvent:
type: string
description: Zip code of branch./ PSČ provozovny ČP.
example: '10008'
description: Extraordinary request for outstock of the consignment to the external partner. / Mimořádný požadavek o vydání (vrácení) zásilky externímu partnerovi.
For request of verification of the pick-up code before handover to the customer, it is necessary to define URL endpoint with the POST method.
Request body:
{
"pickupCode": "abc1234"
}
Schema description:
schema:
PickupCodeVerification:
type: object
required:
- pickupCode
properties:
pickupCode:
type: string
description: Pickup code of the consignment. / Kód pro vyzvednutí zásilky.
example: 'abc1234'
In responseBody we expect the "externalConsignmentID", which is connected with the pick-up code. Eg.:
{
"externalConsignmentID": "abcd-123456"
}
If there is no Consignment corresponding to the pick-up code, we expect information about non-existence (there is no Consignment for the specified pick-up code).