Set the primary location

PATCH/v1/api/store/{team_slug}/setting/location/{id}/primary

v1Operation ID v1_public_location_primary

Makes this company location the team's primary location (its primary billing address) and returns it. The previous primary location stops being primary.

Permission

Needs the Manage Settings permission.

Side effects

• Tells the team's open web app sessions that the primary location changed.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• idstringrequired

  The company location's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example 5ySODwONuta7hu

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (31)

  • address1string | nullrequired
  • citystring | nullrequired
  • country_codestring | nullrequired
  • hold_stockbooleanrequired

    Whether it is a warehouse that holds stock. Permanent once set.

  • idstringrequired
  • is_current_sourcebooleanrequired

    False for deleted or replaced rows.

  • is_default_warehousebooleanrequired

    The default warehouse for new sales orders.

  • is_primarybooleanrequired

    The team's primary location: its primary billing address. Exactly one.

  • labelstring | nullrequired
  • nexusbooleanrequired

    Whether the team collects sales tax here (tax nexus).

  • revision_numberintegerrequired

    Goes up by one on every saved change. Send it back as base_revision_number to avoid overwriting someone else's edit.

  • rolestringrequired

    Always store_location for company locations.

  • trashedbooleanrequired

    True for a deleted location.

  • address2string | null
  • address_family_idstring | null

    Groups an address with the versions that replaced it.

  • copied_from_address_idstring | null

    The address this one replaced, if any.

  • countrystring | null
  • external_typestring | null
  • is_externalboolean
  • notestring | null
  • owner_idstring | null

    For company locations, the team, encoded with the team's own hash ids. It is not the same string as the team id that Get your company details returns.

  • owner_typestring
  • postal_can_validateboolean
  • postal_is_validboolean
  • postal_validatedboolean
  • postcodestring | null
  • sourcestring
  • statestring | null
  • state_codestring | null
  • superseded_atstring (date-time) | null

    When it was replaced, if it was.

  • superseded_by_address_idstring | null

    The address that replaced this one, if any. Company locations are edited in place, so this is normally null.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No current company location with that id on this team (error.code is null and error.message starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both page_not_found).

  Fix

  Use an id from the list operation and check the team slug.

• 409Not done: the id is a replaced version, or an external or redacted address. current_address holds the current version, when there is one.

  When

  The location is a replaced version, or an external or redacted address. The body is the one Update a company location gives on a 409, {success: false, address_save_result, message}, with save_mode blocked_superseded_historical_address or blocked_external_or_compliance.

  Fix

  Use the current location's id, from current_address in the answer.

Related

• GETList company locations/v1/api/store/{team_slug}/setting/location

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/location/5ySODwONuta7hu/primary' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "address1": "100 Example Street",
    "address2": null,
    "address_family_id": null,
    "city": "Springfield",
    "copied_from_address_id": null,
    "country": "United States",
    "country_code": "US",
    "external_type": null,
    "hold_stock": true,
    "id": "5ySODwONuta7hu",
    "is_current_source": true,
    "is_default_warehouse": true,
    "is_external": false,
    "is_primary": true,
    "label": "Main shop",
    "nexus": true,
    "note": null,
    "owner_id": "U9KHQle41wSkHO",
    "owner_type": "team",
    "postal_can_validate": false,
    "postal_is_valid": false,
    "postal_validated": false,
    "postcode": "62701",
    "revision_number": 1,
    "role": "store_location",
    "source": "company_location",
    "state": "Illinois",
    "state_code": "IL",
    "superseded_at": null,
    "superseded_by_address_id": null,
    "trashed": false
  },
  "status": 200,
  "success": true
}