Admin API/Common objects/Queries

deliveryApiSettings

query

Parcel settings of an API-connected delivery account (pickup city, options…), with live choices from the company.

Returns JSON

query DeliveryApiSettings($carrierAccountId: ID!) {
  deliveryApiSettings(carrierAccountId: $carrierAccountId)
}

# Variables
{
  "carrierAccountId": "gid://ostorya/CarrierAccount/0f8c5b1e-…"
}

Arguments

carrierAccountIdID!required

Example

query DeliveryApiSettings($carrierAccountId: ID!) {
  deliveryApiSettings(carrierAccountId: $carrierAccountId)
}

# Variables
{
  "carrierAccountId": "gid://ostorya/CarrierAccount/0f8c5b1e-…"
}

Built from the schema: adjust the selected fields to what you need. Inside an app, bridge comes from App Bridge (https://dev.ostorya.com/app-bridge/v1.mjs, shell https://ostorya.com).