List shipping services the creator is eligible for.

GET

/v1/shipping-services

const url = 'https://api.staging.elasticstage.com/store/v1/shipping-services';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.staging.elasticstage.com/store/v1/shipping-services \
  --header 'Authorization: Bearer <token>'

Authorizations

oauth2
shipping:read

Responses

200

Default Response

application/json

object

data

required

Array<object>

object

required

string

name

required

string

description

Any of:

string
null

string

regions

Array<string>

Example

{
  "data": [
    {
      "id": "standard_eu",
      "name": "Standard (EU)",
      "description": "Tracked delivery across the EU.",
      "regions": [
        "EU"
      ]
    }
  ]
}

401

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "error": "Unauthorized",
  "message": "Authentication required."
}

403

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 403,
  "code": "FORBIDDEN",
  "error": "Forbidden",
  "message": "Insufficient permissions."
}

429

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "error": "Too Many Requests",
  "message": "Rate limit exceeded."
}

500

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 500,
  "code": "INTERNAL_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

503

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "statusCode": 503,
  "code": "SERVICE_UNAVAILABLE",
  "error": "Service Unavailable",
  "message": "The service is temporarily unavailable."
}