diff --git a/pull/36781/index.html b/pull/36781/index.html index 6d3902a..b964723 100644 --- a/pull/36781/index.html +++ b/pull/36781/index.html @@ -1024,6 +1024,11 @@

Rate Limiting

Each webhook subscription has its own secret key which can be found in the particular webhook subscription settings.</p> <h3 id="retries">Retries</h3> <p>If the response status code is not a <code>2xx</code> then we will retry the webhook for 5 attempts with an exponential backoff.</p> +<div class="warning"> + +<p>Please note, that webhook notifications are only available for <em>Internal Orders</em>. +The possibility to subscribe to the <em>External Orders</em> events will be added soon.</p> +</div> ">

ℹ️ Ankorstore provides a mechanism of webhook notifications to notify you of events that happen on the platform.

Subscribing

To subscribe to events please go to the Applications section in your account area.

@@ -1075,6 +1080,11 @@

Signature

Each webhook subscription has its own secret key which can be found in the particular webhook subscription settings.

Retries

If the response status code is not a 2xx then we will retry the webhook for 5 attempts with an exponential backoff.

+
+ +

Please note, that webhook notifications are only available for Internal Orders. +The possibility to subscribe to the External Orders events will be added soon.

+

Testing API

Available operations on Interna </tr> <tr> <td>Email</td> -<td><a href="mailto:&#x6a;&#111;&#104;&#110;&#64;&#97;&#x63;&#109;&#101;&#46;&#x63;&#x6f;&#109;">&#x6a;&#111;&#104;&#110;&#64;&#97;&#x63;&#109;&#101;&#46;&#x63;&#x6f;&#109;</a></td> +<td><a href="mailto:&#106;&#x6f;&#x68;&#x6e;&#x40;&#97;&#x63;&#109;&#x65;&#46;&#99;&#111;&#109;">&#106;&#x6f;&#x68;&#x6e;&#x40;&#97;&#x63;&#109;&#x65;&#46;&#99;&#111;&#109;</a></td> </tr> <tr> <td>Address</td> @@ -2506,7 +2516,7 @@

A practical example

Email -john@acme.com +john@acme.com Address @@ -3855,7 +3865,7 @@

Pickup is not accepted

" class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW">

Unprocessable Entity : Data provided are invalid

Request samples

Content type
application/vnd.api+json
Example
{
  • "order": {
    • "trackingProvider": "ups",
    • "trackingNumber": "123456"
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "jsonapi": {
    • "version": "1.0"
    },
  • "data": {
    • "type": "order",
    • "id": "1ecb023e-7ec0-6d5c-a477-0242ac170007",
    • "attributes": {
      • "status": "brand_confirmed",
      • "reference": 3434273911,
      • "brandCurrency": "EUR",
      • "brandNetAmount": 10229,
      • "brandTotalAmount": 10940,
      • "brandTotalAmountVat": 602,
      • "brandTotalAmountWithVat": 11542,
      • "brandRejectReason": null,
      • "retailerRejectReason": null,
      • "retailerCancellationRequestReason": null,
      • "billingName": "Charles Attan",
      • "billingOrganisationName": "Jumbo",
      • "billingStreet": "Kortricklaan 101",
      • "billingPostalCode": "8121 GW",
      • "billingCity": "Arnhem",
      • "billingCountryCode": "NL",
      • "submittedAt": "2022-03-17T13:19:33+00:00",
      • "shippedAt": null,
      • "brandPaidAt": null,
      • "createdAt": "2022-02-01T14:37:10+00:00",
      • "updatedAt": "2022-03-31T15:10:07+00:00",
      • "shippingMethod": "custom",
      • "shippingOverview": {
        }
      }
    }
}