API Reference

Shipping Status Update

patch
https://api.zenki.fi/v1/pay/orders//tracking/

Based on the order id and the tracking id the delivery status is updated.

Path Params
string
required

Unique order identifier generated by Zenkipay.

string
required

Unique tracking identifier generated by Zenkipay.

Body Params

A JSON structure will be sent that will have the required information to update the shipping status.

string
enum
required

Delivery process states.

Possible values:

  • TRANSIT - In delivery process.
  • DELIVERY - The product or service has been delivered.
  • AVAILABLE_FOR_PICKUP - The product or service is ready for the buyer to pick it up at the store.
  • CANCELED - The shipment has been cancelled.
  • FAILED - There was a problem trying to deliver the product or service.
Allowed:
string
required
length ≤ 255

Place where the event is triggered and the packet is located.

string
required
length ≤ 255

Detail of the error for which the shipment could not be completed or if the product or service was delivered correctly, indicate who received it.

Headers
string

Unique customer identifier used to establish connection with Zenkipay services.

string

Indicates the language type code for which the content of the services response is returned according to the language reported.

The definition of the ISO_639 standard is used. See: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes or https://www.iso.org/iso-639-language-codes.html

string
required

Content type accepted.

string
required

Accepted formats.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
ACCESS_TOKEN
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago