API Reference

Delivery Providers

Connect external delivery providers.

5 endpoints· Auth: API Key
get/api/v1/store/integrations/delivery-providers API Key

Get delivery-providers

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/delivery-providers" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com
Set credentials in the “Authorize” menu
post/api/v1/store/integrations/delivery-providers/links API Key

Create links

Request body

application/json
{
  "providerId": "00000000-0000-0000-0000-000000000000",
  "username": "string",
  "password": "string"
}
providerId
string (uuid)
—
username
string
—
password
string
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/delivery-providers/links" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "providerId": "00000000-0000-0000-0000-000000000000",
  "username": "string",
  "password": "string"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/delivery-providers/orders/{orderId}/sync-status API Key

Create sync-status

Path parameters

orderIdrequired
string (uuid)
—

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/delivery-providers/orders/{orderId}/sync-status" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu