Set a store's business profile

Full-replacement update of the store’s business profile. Shipping zones may be supplied here as a manual override/seed; connector ingestion otherwise sources fulfillment data.

PUT/stores/{store_id}/profile

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Path parameters

store_idstringrequired

A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.

Request body

requiredapplication/json

legal_namestring

support_emailstring<email>

domainstring<uri>

return_policy_urlstring<uri>

fulfillment_regionsstring[]

shipping_zonesobject

Responses

200

Updated store profile.

store_idstring

legal_namestring

support_emailstring<email>

domainstring<uri>

The store's storefront/brand domain where /.well-known/ucp is served.

return_policy_urlstring<uri>

URL of this store's return policy.

fulfillment_regionsstring[]

shipping_zonesobject

Shipping zones keyed by zone id.

404

Resource not found within the caller's tenant.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

detailsobject | null

422

Request body failed validation.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

detailsobject | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

store_idpath*A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.

Bodyapplication/json

Request body

Request

curl -X PUT "https://api.sarvex.example.com/v1/stores/string/profile" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "legal_name": "string",
  "support_email": "user@example.com",
  "domain": "http://example.com",
  "return_policy_url": "http://example.com",
  "fulfillment_regions": [
    "string"
  ],
  "shipping_zones": {
    "property1": {
      "id": "string",
      "name": "string",
      "rates": [
        {
          "method": "string",
          "cost": {
            "amount_minor": 0,
            "currency": "AUD"
          }
        }
      ]
    },
    "property2": {
      "id": "string",
      "name": "string",
      "rates": [
        {
          "method": "string",
          "cost": {
            "amount_minor": 0,
            "currency": "AUD"
          }
        }
      ]
    }
  }
}'

const response = await fetch("https://api.sarvex.example.com/v1/stores/string/profile", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"legal_name\": \"string\",\n  \"support_email\": \"user@example.com\",\n  \"domain\": \"http://example.com\",\n  \"return_policy_url\": \"http://example.com\",\n  \"fulfillment_regions\": [\n    \"string\"\n  ],\n  \"shipping_zones\": {\n    \"property1\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"rates\": [\n        {\n          \"method\": \"string\",\n          \"cost\": {\n            \"amount_minor\": 0,\n            \"currency\": \"AUD\"\n          }\n        }\n      ]\n    },\n    \"property2\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"rates\": [\n        {\n          \"method\": \"string\",\n          \"cost\": {\n            \"amount_minor\": 0,\n            \"currency\": \"AUD\"\n          }\n        }\n      ]\n    }\n  }\n}"
});

import requests

response = requests.put(
    "https://api.sarvex.example.com/v1/stores/string/profile",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"legal_name\": \"string\",\n  \"support_email\": \"user@example.com\",\n  \"domain\": \"http://example.com\",\n  \"return_policy_url\": \"http://example.com\",\n  \"fulfillment_regions\": [\n    \"string\"\n  ],\n  \"shipping_zones\": {\n    \"property1\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"rates\": [\n        {\n          \"method\": \"string\",\n          \"cost\": {\n            \"amount_minor\": 0,\n            \"currency\": \"AUD\"\n          }\n        }\n      ]\n    },\n    \"property2\": {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"rates\": [\n        {\n          \"method\": \"string\",\n          \"cost\": {\n            \"amount_minor\": 0,\n            \"currency\": \"AUD\"\n          }\n        }\n      ]\n    }\n  }\n}",
)

Response

{
  "store_id": "string",
  "legal_name": "string",
  "support_email": "user@example.com",
  "domain": "http://example.com",
  "return_policy_url": "http://example.com",
  "fulfillment_regions": [
    "AU"
  ],
  "shipping_zones": {
    "property1": {
      "id": "string",
      "name": "string",
      "rates": [
        {
          "method": "string",
          "cost": {
            "amount_minor": 0,
            "currency": "AUD"
          }
        }
      ]
    },
    "property2": {
      "id": "string",
      "name": "string",
      "rates": [
        {
          "method": "string",
          "cost": {
            "amount_minor": 0,
            "currency": "AUD"
          }
        }
      ]
    }
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}