GET /v1/commerce/delivery-methods

GET/v1/commerce/delivery-methods

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsDeliveryMethod[] | nullrequired

Show properties

Array of DeliveryMethod

activebooleanrequired

blackout_datesstring[] | null

codestringrequired

fee_amountinteger<int64>required

idstringrequired

method_typestringrequired

namestringrequired

pickup_address_labelstring

schedule_enabledbooleanrequired

service_hoursServiceHour[] | null

Show properties

Array of ServiceHour

closestringrequired

openstringrequired

weekdayinteger<int64>required

sort_orderinteger<int32>required

timeslotsstring[] | null

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/delivery-methods"

const response = await fetch("/v1/commerce/delivery-methods", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/delivery-methods",
)

Response

{
  "items": [
    {
      "active": true,
      "blackout_dates": [
        "string"
      ],
      "code": "string",
      "fee_amount": 0,
      "id": "string",
      "method_type": "string",
      "name": "string",
      "pickup_address_label": "string",
      "schedule_enabled": true,
      "service_hours": [
        {
          "close": "string",
          "open": "string",
          "weekday": 0
        }
      ],
      "sort_order": 0,
      "timeslots": [
        "string"
      ]
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}