POST /v1/commerce/delivery-methods

POST/v1/commerce/delivery-methods

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

blackout_datesstring[] | null

codestringrequired

fee_amountinteger<int64>required

min 0

method_typestringrequired

Allowed:deliverypickup

namestringrequired

pickup_address_labelstring

schedule_enabledboolean

service_hoursServiceHour[] | null

Show properties

Array of ServiceHour

closestringrequired

openstringrequired

weekdayinteger<int64>required

sort_orderinteger<int32>

timeslotsstring[] | null

Responses

201Created

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 POST "/v1/commerce/delivery-methods" \
  -H "Content-Type: application/json" \
  -d '{
  "blackout_dates": [
    "string"
  ],
  "code": "string",
  "fee_amount": 0,
  "method_type": "delivery",
  "name": "string",
  "pickup_address_label": "string",
  "schedule_enabled": true,
  "service_hours": [
    {
      "close": "string",
      "open": "string",
      "weekday": 0
    }
  ],
  "sort_order": 0,
  "timeslots": [
    "string"
  ]
}'

const response = await fetch("/v1/commerce/delivery-methods", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "blackout_dates": [
    "string"
  ],
  "code": "string",
  "fee_amount": 0,
  "method_type": "delivery",
  "name": "string",
  "pickup_address_label": "string",
  "schedule_enabled": true,
  "service_hours": [
    {
      "close": "string",
      "open": "string",
      "weekday": 0
    }
  ],
  "sort_order": 0,
  "timeslots": [
    "string"
  ]
})
});

import requests

response = requests.post(
    "/v1/commerce/delivery-methods",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "blackout_dates": [
    "string"
  ],
  "code": "string",
  "fee_amount": 0,
  "method_type": "delivery",
  "name": "string",
  "pickup_address_label": "string",
  "schedule_enabled": True,
  "service_hours": [
    {
      "close": "string",
      "open": "string",
      "weekday": 0
    }
  ],
  "sort_order": 0,
  "timeslots": [
    "string"
  ]
},
)

Response

{
  "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"
  }
}