Get a brand profile

Open .md

GET/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}

v1Operation ID v1_public_customer_profile_show

Returns one live brand profile of the customer.

Permission

Any member of the team.

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 brand profile's id (id from List a customer's brand profiles). 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 (12)
- address_idstring | nullrequired
  The Ship From address, or null for a profile that has none.
- company_namestring | nullrequired
- customer_idstringrequired
- idstringrequired
- is_primarybooleanrequired
  New sales orders and quotes for the customer use the primary profile.
- trashedbooleanrequired
- use_custom_logobooleanrequired
- addressobject | null
  The Ship From address (an address, as in Customer addresses, without used_by_active_profile), or null.
  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.
- emailstring | null
- logoobject | null
  The newest logo file (a file, as in Customer files), or null.
  Child fields (18)
  - collectionstringrequired
    Customer files: tax_exemption, internal_file or external_file. Vendor files: default, mockup or production_file.
  - created_atstring (date-time)required
  - file_namestringrequired
  - idstringrequired
  - mime_typestring | nullrequired
  - namestring | nullrequired
    The display name.
  - sizeintegerrequired
    Bytes.
  - custom_propertiesobject | array
  - customer_idstring
    Customer files only.
  - dimensionsobject | null
    Pixel size of an image, read from its header; null for other files and for images uploaded before the size was recorded.
    Child fields (2)
    heightinteger
    widthinteger
  - is_imageboolean
  - positioninteger | null
    Where the file sorts.
  - previewobject | null
    Preview image links small, medium and large (250, 800 and 1200 px), or null when there is no preview.
  - preview_statestring
    ready: the preview links work. processing: an image over 10 MB whose stored preview a worker is still making (seconds); read the file again, or in the web app wait for media.preview_state_changed on the team channel. too_large: an image over 120 megapixels; it never gets a preview. failed: the worker gave up. none: not an image.
    One of: "ready", "processing", "too_large", "failed", "none"
  - show_in_pdfboolean | null
  - source_media_idstring | null
  - urlstring | null
    Where to download the file.
  - view_urlstring | null
    A signed link to view the file. It expires: read it fresh, and don't store it.
- phonestring | null
- websitestring | null
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.
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.

PATCHUpdate a brand profile (same as PUT)/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed/profile/uAu3dAKIaHyAYk' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

{
  "data": {
    "address": {
      "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
    },
    "address_id": "KKhhlVobndGXEj",
    "company_name": "Northwind Apparel",
    "customer_id": "V4keXwwxMQyXw7",
    "email": "alex@example.com",
    "id": "Sd836BkLvOWpuP",
    "is_primary": true,
    "logo": null,
    "phone": "+1 201 555 0123",
    "trashed": false,
    "use_custom_logo": false,
    "website": "https://example.com"
  },
  "status": 200,
  "success": true
}

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI spec Support: support@yoprint.com yoprint.com