/wix-manage

Set Up Store Pickup Location

Routing rule: BEFORE taking any action, call ReadFullDocsArticle on Shipping API Reference. The endpoint shapes for List Installed Delivery Carriers, Query Delivery Profiles, Add Delivery Region, and Add Delivery Carrier all live there. Do NOT call any of these APIs without loading it first.

Prerequisites

• Wix Stores (or another eCommerce business solution) installed on the site
• The Pickup carrier must be installed on the site (it is a built-in carrier, not a third-party app)

Required APIs

• List Installed Delivery Carriers
• Query Delivery Profiles
• Add Delivery Region
• Add Delivery Carrier

Step 1: Discover the Pickup carrier

Call List Installed Delivery Carriers to find the Pickup carrier's id.

Endpoint: GET https://www.wixapis.com/ecom/v1/delivery-profiles/installed-carriers

Response:

{
  "installedDeliveryCarriers": [
    {
      "id": "50d8c12f-715e-41ad-be25-d0f61375dbee",
      "displayName": "Pickup",
      "fallbackDefinitionMandatory": false,
      "toggleGetCarrierSettingsEnabled": true
    },
    {
      "id": "45c44b27-ca7b-4891-8c0d-1747d588b835",
      "displayName": "Basic Shipping",
      "description": "Manage shipping rates and options for this region",
      "fallbackDefinitionMandatory": false,
      "toggleGetCarrierSettingsEnabled": true
    }
  ]
}

Look for the carrier with "displayName": "Pickup" and save its id. This is the appId you will use in Step 4.

If no Pickup carrier appears in the list, the Pickup app is not installed on the site and must be installed before proceeding.

Step 2: Find the default delivery profile

Call Query Delivery Profiles to retrieve the site's default delivery profile.

Endpoint: POST https://www.wixapis.com/ecom/v1/delivery-profiles/query

Request:

{}

The response contains an array of deliveryProfiles. Find the one where "default": true. Save its id and revision. Inspect its deliveryRegions array.

Decision point:

• Region exists for the user's country (match on destinations[].countryCode): save that region's id → skip to Step 4.
• No matching region: proceed to Step 3.

Step 3: Add a delivery region for the pickup country

If no region exists for the user's country in the default profile, call Add Delivery Region to create one.

Endpoint: POST https://www.wixapis.com/ecom/v1/delivery-profiles/{deliveryProfileId}/delivery-region

Replace {deliveryProfileId} with the default profile's id from Step 2.

Request:

{
  "deliveryRegion": {
    "name": "US Pickup",
    "active": true,
    "destinations": [
      {
        "countryCode": "US"
      }
    ]
  },
  "revision": "3"
}

• name: descriptive, e.g. "{Country} Pickup".
• countryCode: ISO-3166 alpha-2 code (e.g. "US", "IL", "DE", "GB").
• revision: from the profile returned in Step 2.

Response:

{
  "deliveryProfile": {
    "id": "02625bf4-70b4-49b7-93f0-5c9d72608937",
    "name": "General profile",
    "default": true,
    "deliveryRegions": [
      {
        "id": "23823d4a-0ad2-4f92-a48a-467497a9470a",
        "name": "US Pickup",
        "active": true,
        "deliveryCarriers": [],
        "destinations": [
          {
            "countryCode": "US",
            "subdivisions": []
          }
        ]
      }
    ],
    "revision": "4"
  }
}

Save the new region's id from the response.

Step 4: Add the Pickup carrier to the region

Call Add Delivery Carrier to attach the Pickup carrier to the delivery region.

Endpoint: POST https://www.wixapis.com/ecom/v1/delivery-profiles/add-delivery-carrier

Request:

{
  "deliveryRegionId": "<REGION_ID>",
  "deliveryCarrier": {
    "appId": "50d8c12f-715e-41ad-be25-d0f61375dbee",
    "backupRate": {
      "title": "Pickup at 123 Main St, New York",
      "amount": "0",
      "active": true
    }
  }
}

• deliveryRegionId: from Step 2 (existing region) or Step 3 (new region).
• appId: the Pickup carrier id from Step 1.
• backupRate.title: the pickup address customers see at checkout.
• backupRate.amount: "0" for free pickup, or a price string like "5.00".
• backupRate.active: must be true for the option to appear at checkout.

Response:

{
  "deliveryProfile": {
    "id": "02625bf4-70b4-49b7-93f0-5c9d72608937",
    "name": "General profile",
    "default": true,
    "deliveryRegions": [
      {
        "id": "23823d4a-0ad2-4f92-a48a-467497a9470a",
        "name": "US Pickup",
        "active": true,
        "deliveryCarriers": [
          {
            "appId": "50d8c12f-715e-41ad-be25-d0f61375dbee",
            "backupRate": {
              "title": "Pickup at 123 Main St, New York",
              "amount": "0",
              "active": true
            },
            "additionalCharges": []
          }
        ],
        "destinations": [
          {
            "countryCode": "US",
            "subdivisions": []
          }
        ]
      }
    ],
    "revision": "5"
  }
}

Error Handling

Related Documentation

• API: Shipping Delivery