Skip to main content
GET
/
vendor
/
shipping-profiles
List shipping profiles
curl --request GET \
  --url https://api.example.com/vendor/shipping-profiles \
  --header 'Authorization: Bearer <token>'
{
  "shipping_profiles": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "count": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields
string

The comma-separated fields to include in the response

q
string

Search term to filter shipping profiles by name

offset
number

The number of items to skip before starting to collect the result set

limit
number

The number of items to return

order
string

The order of the returned items

Response

200 - application/json

OK

shipping_profiles
object[]
count
integer

The total number of items available

offset
integer

The number of items skipped before these items

limit
integer

The number of items per page