Set the primary address

PATCH/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/primary

v1Operation ID v1_public_customer_address_primary

Makes this address the customer's primary address of its role (billing or shipping); the previous one stops being primary. Returns the address.

Permission

Needs the Manage Customers permission ("Manage All" or "Manage Assigned to User"). Whether the customer is assigned to you is not checked.

Business rules

• Only a current address: one replaced by an edit, synced from another system or redacted is refused with 409 (address_save_result.current_address is the one to use).
• Addresses synced from Shopify are read-only (422).
• Customers synced from Shopify are read-only here: changes are refused with 422 validation_error "External customers are read-only. Manage changes from Shopify." System customers (is_system: true) are refused the same way ("System customer cannot be modified or deleted.").

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The customer's id (id from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed
• idstringrequired

  The address's id (id from List a customer's addresses). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example uAu3dAKIaHyAYk

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (33)

  • address1string | nullrequired
  • idstringrequired
  • is_current_sourcebooleanrequired

    False for deleted, replaced, Shopify or redacted addresses. Only current addresses can be picked for new documents or edited.

  • is_primarybooleanrequired
  • labelstring | nullrequired
  • revision_numberintegerrequired

    Goes up by one on every saved change. Send it back as base_revision_number when updating the address to protect against concurrent edits.

  • rolestringrequired

    billing or shipping for customer addresses.

  • trashedbooleanrequired
  • address2string | null
  • address_family_idstring | null

    Shared by an address and the copies made when it was edited after use.

  • citystring | null
  • copied_from_address_idstring | null
  • countrystring | null
  • country_codestring | null
  • customer_idstring

    Customer addresses only: the customer's id.

  • external_typestring | null

    shopify for an address synced from Shopify.

  • hold_stockboolean

    Company locations only; false for customer addresses.

  • is_default_warehouseboolean

    Company locations only; false for customer addresses.

  • is_externalboolean

    True for an address synced from Shopify; such addresses are read-only.

  • nexusboolean

    Company locations only; false for customer addresses.

  • notestring | null
  • owner_idstring | null

    The owner's id: for a customer address, the customer's id (the same as customer_id).

  • owner_typestring

    customer for customer addresses.

    • One of: "customer", "team", "unknown"
  • postal_can_validateboolean
  • postal_is_validboolean
  • postal_validatedboolean

    True once YoPrint has checked the address with its address validator. postal_can_validate says whether it could be checked and postal_is_valid gives the result. Any edit resets it to false.

  • postcodestring | null
  • sourcestring

    customer for customer addresses.

    • One of: "customer", "company_location", "custom", "unknown"
  • statestring | null
  • state_codestring | null
  • superseded_atstring (date-time) | null
  • superseded_by_address_idstring | null

    Set on an old copy: the address that replaced it.

  • used_by_active_profileboolean

    True when a brand profile uses it as Ship From. Sent on lists, reads, updates and customer answers; not on create or set-primary.

• statusintegerrequired
• successbooleanrequired

Errors

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

• 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 role has no Manage Customers permission. This 403 has a short body, {"message": "Insufficient Permission"}, with no success or error.

  Fix

  Ask a team owner to give your role Manage Customers.

• 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

  The address is deleted or not this customer's. error.code is null and error.message names the record type.

  Fix

  Restore it first.

• 409The address is an old copy replaced by an edit (blocked_superseded_historical_address; current_address is the copy to use), or it is synced from another system or redacted (blocked_external_or_compliance; current_address is the same address). Not the usual error envelope: success: false, address_save_result and message (the save_mode); no status or error.

  When

  The address is not current: replaced by an edit (address_save_result.save_mode blocked_superseded_historical_address), or synced from another system or redacted (blocked_external_or_compliance). Not the usual error envelope: the body has success: false, address_save_result and message.

  Fix

  For a replaced address, use address_save_result.current_address.id. A synced or redacted address can't be changed.

• 422Validation failed or external Shopify customers are read-only from this API.

  When

  The address is synced from Shopify (validation_error, "Shopify-managed customer addresses are read-only. Manage changes from Shopify.").

  Fix

  Change it in Shopify.

  When

  The customer comes from Shopify, or is a system customer (error.code validation_error, with the reason in error.message).

  Fix

  Change Shopify customers in Shopify. System customers cannot be changed.

Related

• GETList a customer's addresses/v1/api/store/{team_slug}/customer/{hash_id}/address

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed/address/uAu3dAKIaHyAYk/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": "Suite 200",
    "address_family_id": null,
    "city": "Springfield",
    "copied_from_address_id": null,
    "country": "United States",
    "country_code": "US",
    "customer_id": "V4keXwwxMQyXw7",
    "external_type": null,
    "hold_stock": false,
    "id": "KKhhlVobndGXEj",
    "is_current_source": true,
    "is_default_warehouse": false,
    "is_external": false,
    "is_primary": true,
    "label": "Head office",
    "nexus": false,
    "note": null,
    "owner_id": "V4keXwwxMQyXw7",
    "owner_type": "customer",
    "postal_can_validate": false,
    "postal_is_valid": false,
    "postal_validated": false,
    "postcode": "62701",
    "revision_number": 1,
    "role": "billing",
    "source": "customer",
    "state": "Illinois",
    "state_code": "IL",
    "superseded_at": null,
    "superseded_by_address_id": null,
    "trashed": false
  },
  "status": 200,
  "success": true
}