Get shipping configurations

GET

/api/v2/shipping_configs

• Veeqo API Production Server

Retrieve available shipping configurations for the company. Use the id field from this response in the shipping_configuration_ids parameter when requesting rates.

Parameters

Query Parameters

page

integer

default: 1 >= 1

Page number for pagination

per_page

integer

default: 25 >= 1 <= 100

Number of results per page

include

string

Allowed values: shipping_services

Include related resources (comma-separated)

Example

shipping_services

filter[enabled]

boolean

Filter by enabled/connected status

Responses

200

Successful response with shipping configurations

object

data

Array<object>

object

id

Provider type or normalized name

string

amazon_shipping_v2

type

Resource type

string

shipping_config

attributes

object

id

Internal shipping config ID

integer

nullable

123

carrier_id

Carrier ID

integer

45

name

Carrier name

string

Amazon Shipping V2

provider_type

Provider type identifier

string

amazon_shipping_v2

shipping_service_options

Available service options

Array<object>

object

show_when_shipping

Whether to show when shipping

boolean

true

is_configured

Whether the config is set up

boolean

true

config

Configuration parameters

object

validates

Validation rules

object

default_for_carrier

Whether this is the default config for the carrier

boolean

true

nickname

User-defined nickname for the config

string

nullable

My Amazon Account

requires_reconnect

Whether the config needs to be reconnected

boolean

connected

Whether the config is connected

boolean

true

connected_off_amazon

Whether connected outside of Amazon

boolean

available_shipping_services_count

Count of non-hidden shipping services

integer

15

total_shipping_service_count

Total count of shipping services

integer

20

relationships

object

shipping_services

object

data

Array<object>

object

id

string

type

string

shipping_service

meta

object

page

integer

1

per_page

integer

25

total_pages

integer

1

total_count

integer

5

included

Included shipping services (when include=shipping_services)

Array<object>

object

id

Shipping service ID

string

1

type

Resource type

string

shipping_service

attributes

object

service_id

Service identifier

string

USPS_PTP_GRN

name

Service name

string

USPS Ground Advantage

hidden

Whether the service is hidden

boolean

Example

{
  "data": [
    {
      "id": "amazon_shipping_v2",
      "type": "shipping_config",
      "attributes": {
        "id": 123,
        "carrier_id": 45,
        "name": "Amazon Shipping V2",
        "provider_type": "amazon_shipping_v2",
        "show_when_shipping": true,
        "is_configured": true,
        "connected": true,
        "connected_off_amazon": false,
        "default_for_carrier": true,
        "nickname": "My Amazon Account",
        "requires_reconnect": false,
        "available_shipping_services_count": 15,
        "total_shipping_service_count": 20
      },
      "relationships": {
        "shipping_services": {
          "data": [
            {
              "id": "1",
              "type": "shipping_service"
            },
            {
              "id": "2",
              "type": "shipping_service"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "shipping_service",
      "attributes": {
        "service_id": "USPS_PTP_GRN",
        "name": "USPS Ground Advantage",
        "hidden": false
      }
    },
    {
      "id": "2",
      "type": "shipping_service",
      "attributes": {
        "service_id": "USPS_PTP_PRI",
        "name": "USPS Priority Mail",
        "hidden": false
      }
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_pages": 1,
    "total_count": 1
  }
}

403

Forbidden - insufficient permissions

object

errors

Array<object>

object

status

string

403

title

string

Forbidden

detail

string

You don't have permission to access this resource