Journey Token Creation

Note:

• For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

• For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

CreateJourney

POST$BASE_URL.Zalo/CreateJourney

Body

application/json

oa_idstring (int64)

phonestring

token_typeuqTokenType (enum)

unknowntoken_logistics_7token_logistics_30token_coach_bus_7token_coach_bus_30

Response

200

A successful response

Body

application/json

created_atstring (date-time)

error_codeinteger

error_messagestring

expired_atstring (date-time)

idstring (int64)

is_chargedboolean

journey_idstring (int64)

journey_tokenstring

phonestring

statusblStatus (enum)

ZPN

updated_atstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Zalo/CreateJourney', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "created_at": "2025-01-09T12:06:37.341Z",
  "error_code": 0,
  "error_message": "text",
  "expired_at": "2025-01-09T12:06:37.341Z",
  "id": "text",
  "is_charged": false,
  "journey_id": "text",
  "journey_token": "text",
  "phone": "text",
  "status": "Z",
  "updated_at": "2025-01-09T12:06:37.341Z"
}

Request:

curl --location '$BASE_URL.Zalo/CreateJourney' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
    "oa_id": "<int64>",
    "phone": "<string>",
    "token_type": "unknown"
}'

Response:

{
  "created_at": "2019-08-24T14:15:22Z",
  "error_code": 0,
  "error_message": "string",
  "expired_at": "2019-08-24T14:15:22Z",
  "id": "string",
  "is_charged": true,
  "journey_id": "string",
  "journey_token": "string",
  "phone": "string",
  "status": "Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Request body structure

Parameters	Data type	Describe
oa_id require	int64	OA ID
phone require	string	Recipient's phone number. Note: Phone number must be linked to Zalo account
token_type	string (uqTokenType) Enum	" unknown" " token_logistics_7" token_logistics_30" " token_coach_bus_7" " token_coach_bus_30" If no token_type is passed the default istoken_logistics_7

Return data attribute structure

Parameters	Data type	Describe
id	int64	Journey ID on eTelecom system
journey_id	string	Journey ID
journey_token	string	Trip code activated
expires_at	string<date-time>	Expiration time
phone	string	Recipient phone number
status	string	Status Z: Newly created P: Enable N: Disable
error_code	int	Error code
error_message	string	Error information
is_charged	bool	To charge or not to charge
updated_at	string<date-time>	Update time
created_at	string<date-time>	Creation time