Update a company location

PUT/v1/api/store/{team_slug}/setting/location/{hash_id}

v1Operation ID v1_public_location_update_put

Changes a location's address, label, note or tax nexus in place: the id stays the same, so every order, purchase order and stock record that uses it shows the new address.

The response is not in the usual envelope: it is {success, address_save_result, data}, with no status key. The save_mode in address_save_result says what happened: updated_operational_location_in_place, or no_address_fields_changed when nothing differed.

Send base_revision_number (the revision_number you read) to avoid overwriting someone else's edit: if it no longer matches, nothing is saved and you get 409 stale_address.

Permission

Needs the Manage Settings permission.

Business rules

• Only the address fields, label, note and nexus are saved. is_primary and warehouse settings have their own operations.
• For US and Canadian addresses, state or state_code must be a real state or province. Send either one and YoPrint fills in the other; when you send both, they must match.
• A deleted location cannot be updated.

Side effects

• Changes the address everywhere it is used, including open orders, purchase orders and new PDFs.
• Turning nexus on or off can change Auto Tax for US-plan teams.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_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

application/json, required.

• address1string
• address2string
• base_revision_numberinteger

  The revision_number you last read. When it no longer matches, nothing is saved and you get 409 stale_address.

• citystring
• countrystring

  The country name. Left out, the stored name stays, even when you change country_code: send both together. With no stored name, answers show the name for country_code.

• country_codestring

  The two-letter country code, such as US. Saved in capitals.

• is_primaryboolean

  Ignored: use Set the primary location.

• labelstring

  A name for the location.

• nexusboolean

  Whether the team collects sales tax here. Left out, it stays as it is.

• notestring
• operation_keystring

  Your own key for this edit, echoed back in address_save_result.

• postcodestring
• statestring | null

  The state or province name. For US and Canadian addresses it must be a real state or province; send it or state_code, and YoPrint fills in the other.

• state_codestring | null

  The state or province code, such as IL. Saved in capitals.

Response

200Saved, or nothing to change.

• successbooleanrequired
  • Always true
• address_save_resultobjectrequired
  Child fields (7)

  • current_addressobject | nullrequired

    On a 409: the location as it is now (for a replaced version, its current version). Null on a 200.

    Child fields (32)

    • 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.

    • used_by_active_profileboolean

      Whether a customer profile uses this address. Normally false for company locations.

  • message_codestringrequired

    The same as save_mode.

  • operation_keystringrequired

    Your operation_key, or one YoPrint made.

  • previous_addressobject | nullrequired
  • replacement_addressobject | nullrequired
  • save_modestringrequired
    • One of: "updated_operational_location_in_place", "no_address_fields_changed", "stale_address", "blocked_superseded_historical_address", "blocked_external_or_compliance"
  • stale_baseobject | nullrequired

    On stale_address: address_id, your base_revision_number and the current_revision_number.

• dataobjectrequired
  Child fields (32)

  • 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.

  • used_by_active_profileboolean

    Whether a customer profile uses this address. Normally false for company locations.

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 saved: the location changed since you read it (stale_address), or it is a replaced, external or redacted row.

  When

  stale_address: base_revision_number doesn't match. Or the row is a replaced version, or an external or redacted address.

  Fix

  Read the location again (current_address holds it), then retry with its revision_number.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  A field has the wrong type, or a US or Canadian state is unknown or doesn't match state_code. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETShow a company location/v1/api/store/{team_slug}/setting/location/{hash_id}

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/location/5ySODwONuta7hu' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "address2": "Unit 4",    "base_revision_number": 1,    "label": "Main shop",    "operation_key": "location-edit-1001"  }'

Example response 200

Response

{
  "address_save_result": {
    "current_address": null,
    "message_code": "updated_operational_location_in_place",
    "operation_key": "location-edit-1001",
    "previous_address": null,
    "replacement_address": null,
    "save_mode": "updated_operational_location_in_place",
    "stale_base": null
  },
  "data": {
    "address1": "100 Example Street",
    "address2": "Unit 4",
    "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": 2,
    "role": "store_location",
    "source": "company_location",
    "state": "Illinois",
    "state_code": "IL",
    "superseded_at": null,
    "superseded_by_address_id": null,
    "trashed": false,
    "used_by_active_profile": false
  },
  "success": true
}