.dev
REST APIAPI Reference

Cloud Parcels

/v1/stores/{storeId}/carrier-accounts

GET
/v1/stores/{storeId}/carrier-accounts

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts"

/v1/stores/{storeId}/carrier-accounts

POST
/v1/stores/{storeId}/carrier-accounts

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts"

/v1/stores/{storeId}/carrier-accounts/{accountId}

GET
/v1/stores/{storeId}/carrier-accounts/{accountId}

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts/string"

/v1/stores/{storeId}/carrier-accounts/{accountId}

DELETE
/v1/stores/{storeId}/carrier-accounts/{accountId}

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X DELETE "https://example.com/v1/stores/string/carrier-accounts/string"

/v1/stores/{storeId}/carrier-accounts/{accountId}

PUT
/v1/stores/{storeId}/carrier-accounts/{accountId}

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X PUT "https://example.com/v1/stores/string/carrier-accounts/string"

/v1/stores/{storeId}/carrier-accounts/{accountId}/fees

GET
/v1/stores/{storeId}/carrier-accounts/{accountId}/fees

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts/string/fees"

/v1/stores/{storeId}/carrier-accounts/{accountId}/fees

PUT
/v1/stores/{storeId}/carrier-accounts/{accountId}/fees

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X PUT "https://example.com/v1/stores/string/carrier-accounts/string/fees"

/v1/stores/{storeId}/carrier-accounts/{accountId}/fees/import

POST
/v1/stores/{storeId}/carrier-accounts/{accountId}/fees/import

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/string/fees/import"

/v1/stores/{storeId}/carrier-accounts/{accountId}/fees/import/{jobId}

GET
/v1/stores/{storeId}/carrier-accounts/{accountId}/fees/import/{jobId}

Path Parameters

storeId*string
accountId*string
jobId*string
storeId*string
accountId*string
jobId*string
storeId*string
accountId*string
jobId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts/string/fees/import/string"

/v1/stores/{storeId}/carrier-accounts/{accountId}/fees/resolve

GET
/v1/stores/{storeId}/carrier-accounts/{accountId}/fees/resolve

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts/string/fees/resolve"

/v1/stores/{storeId}/carrier-accounts/{accountId}/import

POST
/v1/stores/{storeId}/carrier-accounts/{accountId}/import

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/string/import"

/v1/stores/{storeId}/carrier-accounts/{accountId}/remote-parcels

GET
/v1/stores/{storeId}/carrier-accounts/{accountId}/remote-parcels

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts/string/remote-parcels"

/v1/stores/{storeId}/carrier-accounts/{accountId}/sync

POST
/v1/stores/{storeId}/carrier-accounts/{accountId}/sync

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/string/sync"

/v1/stores/{storeId}/carrier-accounts/{accountId}/webhook-events

GET
/v1/stores/{storeId}/carrier-accounts/{accountId}/webhook-events

Path Parameters

storeId*string
accountId*string
storeId*string
accountId*string
storeId*string
accountId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/carrier-accounts/string/webhook-events"

/v1/stores/{storeId}/carrier-accounts/ecotrack-login

POST
/v1/stores/{storeId}/carrier-accounts/ecotrack-login

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/ecotrack-login"

/v1/stores/{storeId}/carrier-accounts/fees/resolve

POST
/v1/stores/{storeId}/carrier-accounts/fees/resolve

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/fees/resolve"

/v1/stores/{storeId}/carrier-accounts/maystro-login

POST
/v1/stores/{storeId}/carrier-accounts/maystro-login

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/maystro-login"

/v1/stores/{storeId}/carrier-accounts/quotes

POST
/v1/stores/{storeId}/carrier-accounts/quotes

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/carrier-accounts/quotes"

/v1/stores/{storeId}/courier-fees

GET
/v1/stores/{storeId}/courier-fees

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/courier-fees"

/v1/stores/{storeId}/courier-fees

POST
/v1/stores/{storeId}/courier-fees

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/courier-fees"

/v1/stores/{storeId}/courier-fees/{feeId}

PATCH
/v1/stores/{storeId}/courier-fees/{feeId}

Path Parameters

storeId*string
feeId*string
storeId*string
feeId*string
storeId*string
feeId*string

Response Body

curl -X PATCH "https://example.com/v1/stores/string/courier-fees/string"

/v1/stores/{storeId}/courier-fees/{feeId}

DELETE
/v1/stores/{storeId}/courier-fees/{feeId}

Path Parameters

storeId*string
feeId*string
storeId*string
feeId*string
storeId*string
feeId*string

Response Body

curl -X DELETE "https://example.com/v1/stores/string/courier-fees/string"

/v1/stores/{storeId}/courier-fees/unassigned

GET
/v1/stores/{storeId}/courier-fees/unassigned

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/courier-fees/unassigned"

/v1/stores/{storeId}/courier-fees/unassigned

PUT
/v1/stores/{storeId}/courier-fees/unassigned

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X PUT "https://example.com/v1/stores/string/courier-fees/unassigned"

/v1/stores/{storeId}/couriers

GET
/v1/stores/{storeId}/couriers

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/couriers"

/v1/stores/{storeId}/label-settings

GET
/v1/stores/{storeId}/label-settings

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/label-settings"

/v1/stores/{storeId}/label-settings

PATCH
/v1/stores/{storeId}/label-settings

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X PATCH "https://example.com/v1/stores/string/label-settings"

/v1/stores/{storeId}/label-templates

GET
/v1/stores/{storeId}/label-templates

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/label-templates"

/v1/stores/{storeId}/label-templates

POST
/v1/stores/{storeId}/label-templates

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/label-templates"

/v1/stores/{storeId}/label-templates/{templateId}

PATCH
/v1/stores/{storeId}/label-templates/{templateId}

Path Parameters

storeId*string
templateId*string
storeId*string
templateId*string
storeId*string
templateId*string

Response Body

curl -X PATCH "https://example.com/v1/stores/string/label-templates/string"

/v1/stores/{storeId}/parcels

GET
/v1/stores/{storeId}/parcels

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/parcels"

/v1/stores/{storeId}/parcels

POST
/v1/stores/{storeId}/parcels

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/parcels"

/v1/stores/{storeId}/parcels{batch}

POST
/v1/stores/{storeId}/parcels{batch}

Path Parameters

storeId*string
storeId*string
storeId*string
batch*string

Response Body

curl -X POST "https://example.com/v1/stores/string/parcelsstring"

/v1/stores/{storeId}/parcels/{parcelId}

GET
/v1/stores/{storeId}/parcels/{parcelId}

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/parcels/string"

/v1/stores/{storeId}/parcels/{parcelId}

DELETE
/v1/stores/{storeId}/parcels/{parcelId}

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X DELETE "https://example.com/v1/stores/string/parcels/string"

/v1/stores/{storeId}/parcels/{parcelId}

PUT
/v1/stores/{storeId}/parcels/{parcelId}

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X PUT "https://example.com/v1/stores/string/parcels/string"

/v1/stores/{storeId}/parcels/{parcelId}/cancel

POST
/v1/stores/{storeId}/parcels/{parcelId}/cancel

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/parcels/string/cancel"

/v1/stores/{storeId}/parcels/{parcelId}/events

GET
/v1/stores/{storeId}/parcels/{parcelId}/events

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/parcels/string/events"

/v1/stores/{storeId}/parcels/{parcelId}/label

GET
/v1/stores/{storeId}/parcels/{parcelId}/label

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X GET "https://example.com/v1/stores/string/parcels/string/label"

/v1/stores/{storeId}/parcels/{parcelId}/send

POST
/v1/stores/{storeId}/parcels/{parcelId}/send

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/parcels/string/send"

/v1/stores/{storeId}/parcels/{parcelId}/sync

POST
/v1/stores/{storeId}/parcels/{parcelId}/sync

Path Parameters

storeId*string
parcelId*string
storeId*string
parcelId*string
storeId*string
parcelId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/parcels/string/sync"

/v1/stores/{storeId}/parcels/labels

POST
/v1/stores/{storeId}/parcels/labels

Path Parameters

storeId*string
storeId*string
storeId*string

Response Body

curl -X POST "https://example.com/v1/stores/string/parcels/labels"

Cloud Order Ship

Previous Page

Cloud Parcels Webhook

Next Page