pickup_location.update

Update a pickup point (partial — an omitted field is left alone). Switching active off takes it out of the checkout immediately; it never rewrites an order that already froze it.

• Scope: shipping.write
• System: no
• Reachable from: POST /v1/commands/pickup_location.update (tenant credential) · MCP tool pickup_location.update · SDK client.call('pickup_location.update', …)
• Events: shipping.config.updated

Input (JSON Schema)

{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "addr_line1": {
      "minLength": 1,
      "type": "string"
    },
    "addr_line2": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "city": {
      "minLength": 1,
      "type": "string"
    },
    "district": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "hours": {
      "additionalProperties": false,
      "properties": {
        "fri": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "mon": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "sat": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "sun": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "thu": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "tue": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "wed": {
          "anyOf": [
            {
              "properties": {
                "close": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                },
                "open": {
                  "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
                  "type": "string"
                }
              },
              "required": [
                "open",
                "close"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "lat": {
      "anyOf": [
        {
          "maximum": 90,
          "minimum": -90,
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "lng": {
      "anyOf": [
        {
          "maximum": 180,
          "minimum": -180,
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "pickup_location_id": {
      "minLength": 1,
      "type": "string"
    },
    "postal_code": {
      "minLength": 1,
      "type": "string"
    },
    "uf": {
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "pickup_location_id"
  ],
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "pickup_location_id": {
      "type": "string"
    }
  },
  "required": [
    "pickup_location_id"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)