Push API

Indication of the status change of the order and the delivery of goods based on physical events.

The notification is sent to predefined (separate) endpoints fixed in the settings of the Webshippy API sales channel (webshippy.api).

The push api arrives at the endpoints defined in the first active sales channel.

In addition to the status of the process, the notification contains the ID and name of the order, the ID and nickname of the goods delivery, as well as when the status change occurred.

Order

Field

Description

id

The unique Webshippy ID of the order.

name

Name of the order. The name entered when the order was created.

status

Order status, possible values:

  • refused

  • fulfilled

updatedAt

Date and time of status change.

Transfer

Field

Description

id

The unique Webshippy identifier of the goods delivery.

nickname

The delivery of goods created with a fantasy name via the API can be searched on the list interface based on its name. When updating the delivery of goods, the fantasy name can also be updated.

status

The status of the goods delivery (shipped).

updatedAt

Date and time of status change.

Last updated