API Reference

Boxy

Boxy delivery provider integration.

22 endpoints· Auth: API Key
get/api/v1/store/integrations/boxy/orders API Key

Get orders

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/orders" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com
Set credentials in the “Authorize” menu
patch/api/v1/store/integrations/boxy/orders/{orderUid} API Key

Update orderUid

Path parameters

orderUidrequired
string

Request body

application/json
{
  "isFragile": false,
  "readyToPickUp": false,
  "shipmentFeeType": "string",
  "paymentType": "string",
  "pickUpType": "string",
  "description": "string",
  "size": "string",
  "customId": "string",
  "feeCustomerPayable": 0,
  "savedPickUpAddressUid": "string",
  "products": [
    {
      "title": "string",
      "price": 0,
      "quantity": 0
    }
  ],
  "contact": {
    "fullName": "string",
    "phone": "string",
    "secondaryPhone": "string",
    "email": "string",
    "addressText": "string",
    "regionName": "string",
    "provinceCode": "string"
  }
}
isFragile
boolean
readyToPickUp
boolean
shipmentFeeType
string
paymentType
string
pickUpType
string
description
string
size
string
customId
string
feeCustomerPayable
integer (int32)
savedPickUpAddressUid
string
products
BoxyProductItem[]
contact
BoxyContactInfo

Responses

200Success
cURL
curl -X PATCH "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/orders/{orderUid}" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "isFragile": false,
  "readyToPickUp": false,
  "shipmentFeeType": "string",
  "paymentType": "string",
  "pickUpType": "string",
  "description": "string",
  "size": "string",
  "customId": "string",
  "feeCustomerPayable": 0,
  "savedPickUpAddressUid": "string",
  "products": [
    {
      "title": "string",
      "price": 0,
      "quantity": 0
    }
  ],
  "contact": {
    "fullName": "string",
    "phone": "string",
    "secondaryPhone": "string",
    "email": "string",
    "addressText": "string",
    "regionName": "string",
    "provinceCode": "string"
  }
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/boxy/orders/{orderUid} API Key

Delete orderUid

Path parameters

orderUidrequired
string

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/orders/{orderUid}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/boxy/orders/{orderUid}/cancel API Key

Create cancel

Path parameters

orderUidrequired
string

Responses

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

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/orders/{orderUid}/label API Key

Get label

Path parameters

orderUidrequired
string

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/orders/{orderUid}/label" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/orders/{orderUid}/status API Key

Get status

Path parameters

orderUidrequired
string

Responses

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

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/orders/by-custom-id/{customId} API Key

Get customId

Path parameters

customIdrequired
string

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/orders/by-custom-id/{customId}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/orders/labels API Key

Get labels

Query parameters

orderUids
string[]

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/orders/labels" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Query parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/pick-up-locations API Key

Get pick-up-locations

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-up-locations" \
  -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/boxy/pick-up-locations API Key

Create pick-up-locations

Request body

application/json
{
  "fullName": "string",
  "type": "string",
  "default": false,
  "regionUid": "string",
  "title": "string",
  "phone": "string",
  "addressText": "string",
  "lng": "string",
  "lat": "string",
  "email": "string",
  "description": "string"
}
fullName
string
type
string
default
boolean
regionUid
string
title
string
phone
string
addressText
string
lng
string
lat
string
email
string
description
string

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-up-locations" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "fullName": "string",
  "type": "string",
  "default": false,
  "regionUid": "string",
  "title": "string",
  "phone": "string",
  "addressText": "string",
  "lng": "string",
  "lat": "string",
  "email": "string",
  "description": "string"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/pick-up-locations/{locationUid} API Key

Get locationUid

Path parameters

locationUidrequired
string

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-up-locations/{locationUid}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
patch/api/v1/store/integrations/boxy/pick-up-locations/{locationUid} API Key

Update locationUid

Path parameters

locationUidrequired
string

Request body

application/json
{
  "fullName": "string",
  "type": "string",
  "default": false,
  "regionUid": "string",
  "title": "string",
  "phone": "string",
  "addressText": "string",
  "lng": "string",
  "lat": "string",
  "email": "string",
  "description": "string"
}
fullName
string
type
string
default
boolean
regionUid
string
title
string
phone
string
addressText
string
lng
string
lat
string
email
string
description
string

Responses

200Success
cURL
curl -X PATCH "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-up-locations/{locationUid}" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "fullName": "string",
  "type": "string",
  "default": false,
  "regionUid": "string",
  "title": "string",
  "phone": "string",
  "addressText": "string",
  "lng": "string",
  "lat": "string",
  "email": "string",
  "description": "string"
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Request body (JSON)

Set credentials in the “Authorize” menu
delete/api/v1/store/integrations/boxy/pick-up-locations/{locationUid} API Key

Delete locationUid

Path parameters

locationUidrequired
string

Responses

200Success
cURL
curl -X DELETE "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-up-locations/{locationUid}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/pick-up-locations/cash-dropoff API Key

Get cash-dropoff

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-up-locations/cash-dropoff" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com
Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/pick-ups API Key

Get pick-ups

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups" \
  -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/boxy/pick-ups API Key

Create pick-ups

Request body

application/json
{
  "orderUids": [
    "string"
  ]
}
orderUids
string[]

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -d '{
  "orderUids": [
    "string"
  ]
}'
Try itagainst staging · https://stagging-api.sendyiq.com

Request body (JSON)

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/pick-ups/{pickupUid} API Key

Get pickupUid

Path parameters

pickupUidrequired
string

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups/{pickupUid}" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/boxy/pick-ups/{pickupUid}/cancel API Key

Create cancel

Path parameters

pickupUidrequired
string

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups/{pickupUid}/cancel" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/pick-ups/{pickupUid}/labels API Key

Get labels

Path parameters

pickupUidrequired
string

Responses

200Success
cURL
curl -X GET "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups/{pickupUid}/labels" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Path parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/boxy/pick-ups/bulk API Key

Create bulk

Query parameters

filterUids
string[]

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups/bulk" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Query parameters

Set credentials in the “Authorize” menu
post/api/v1/store/integrations/boxy/pick-ups/bulk-cancel API Key

Create bulk-cancel

Query parameters

filterUids
string[]

Responses

200Success
cURL
curl -X POST "https://stagging-api.sendyiq.com/api/v1/store/integrations/boxy/pick-ups/bulk-cancel" \
  -H "X-API-Key: <YOUR_API_KEY>"
Try itagainst staging · https://stagging-api.sendyiq.com

Query parameters

Set credentials in the “Authorize” menu
get/api/v1/store/integrations/boxy/regions API Key

Get regions

Responses

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