> For the complete documentation index, see [llms.txt](https://www.apidoc-en.webshippy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.apidoc-en.webshippy.com/webshippy-api-guide/push-api.md).

# 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).

{% hint style="info" %}
The push api arrives at the endpoints defined in the first active sales channel.
{% endhint %}

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** <a href="#megrendeles" id="megrendeles"></a>

| Field       | Description                                                                                                |
| ----------- | ---------------------------------------------------------------------------------------------------------- |
| `id`        | The unique Webshippy ID of the order.                                                                      |
| `name`      | Name of the order. The name entered when the order was created.                                            |
| `status`    | <p>Order status, possible values:</p><ul><li><code>refused</code></li><li><code>fulfilled</code></li></ul> |
| `updatedAt` | Date and time of status change.                                                                            |

#### **Transfer** <a href="#aruszallitas" id="aruszallitas"></a>

| 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.                                                                                                                                                                   |

{% file src="/files/pGD33pRIV4aNEo3zp4Ox" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://www.apidoc-en.webshippy.com/webshippy-api-guide/push-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.