Webhook API (1.0.0)

Download OpenAPI specification:Download

team-order-management: team-order-management@newstore.com URL: newstore.com

This is an internal API for newstore teams, to be called from service-mesh, to send the events payload.

webhook

Webhook events

Create Event

Webhook API is a replacement for events, accepts the event payload and event_name

Request Body schema: application/json

One of

event_name	string Value: "delivery_booked" The store where the order was placed.
	object

Responses

Request samples

Payload

Content type

application/json

{"payload": {"delivery_request_id": "16469b87-a86b-44ba-b5ca-2297cb78f9c1",
"packages": [{"commercial_invoice_url": null,
"cost": {"currency": null,
"price": null
},
"delivery_estimate": {"ends_at": "2017-09-15T16:00:00.000000",
"starts_at": "2017-09-15T14:00:00.000000"
},
"label_url": "https://dodici.v.labels.dmz.newstore.io/ab2887bc-c647-4a61-9219-10d55c60152a.pdf",
"provider": "COURSIER_PRIVE",
"return_commercial_invoice_url": null,
"return_cost": {"currency": null,
"price": null
},
"return_label_url": null,
"return_tracking_code": null,
"return_tracking_url": null,
"tracking_code": "2OXFPDPZ4HADIP2HCNO",
"tracking_url": "http://dashboard.fleeters-preprod.io/tracking/2OXFPDPZ4HADIP2HCNO"
}
],
"timestamp": "2023-06-23T15:37:35.925704",
"sales_order_uuid": "f39bd978-b328-55b1-9477-90330caa6689",
"shipping_option_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ1dWlkIjoiMTQ4MDlmYzktNDQ1ZC00MDgwLWIzMGItNWJjMTZiYjc0OGRhIiwiZnVsZmlsbG1lbnRfbm9kZV9pZCI6IkUyRV9VU18wMV9ORVdfRkxPVyIsInppcF9jb2RlIjoiMTAwMTIiLCJjb3VudHJ5X2NvZGUiOiJVUyIsInNoaXBwaW5nX3R5cGUiOiJ0cmFkaXRpb25hbF9jYXJyaWVyIiwic2VydmljZV9sZXZlbF9pZGVudGlmaWVyIjoiTm9Cb29raW5nIiwiY2Fycmllcl9jb2RlIjoibm8tYm9va2luZyIsInByb3ZpZGVyX3JhdGVfaWRlbnRpZmllciI6Ik5vQm9va2luZyIsImRlbGl2ZXJ5X2VzdGltYXRlIjp7ImlkIjoiT0ZGRVJJRCIsImRlbGl2ZXJ5X3dpbmRvdyI6eyJzdGFydHNfYXQiOiIyMDIzLTA2LTI0VDA4OjQyOjEwLjAwMDAwMFoiLCJlbmRzX2F0IjoiMjAyMy0wNi0yNlQxNjo0MjoxMC4wMDAwMDBaIn19fQ.QQ32EL5TNfw70Z13KEyRjxjAzRP9xzVyOuyiLYWfUbN1JAJKyim6-tWwms1trbLVOaNHXIO4JHCG8vi3nBMUO333bho3Bbboty7ZZ7Cjm9ltYaK1u7WeXVwK5o9MpbtrhgZIE0mhSmlmf20MzTDT7P29-5D_04JTCQjsyLI6cuwTc-vGWUaSOzRbSd615d8n0qv9cpnM2B3KkWTSg6Nzv3Wd2ejPzwvID8_dz8g6Ey36RmZxdN4jF1eoLF6LHAqjWS34HPpRlT6Ds6OGpnu2JASOm1L8KTRtxIEwMVTngwqQ9HlonaAJHTP6dIVPjKykl2giKmxoQtJVF72QaYYUpQ"
},
"event_name": "delivery_booked"
}

Response samples

Content type

application/problem+json

{"error_code": "string",
"message": "string",
"request_id": "string"
}