Customers

API reference › Customers

The people and companies you sell to. A customer holds contacts, billing and shipping addresses, brand profiles, files, tags and a customer credit balance; sales orders, quotes and invoices name a customer.

Learn more: Customers · Create and sync customers

Parts:Contacts (9)Addresses (7)Brand profiles (7)Store credit (3)Files (5)

22 operations

• POSTCreate a customer/v1/api/store/{team_slug}/customerCreates a customer, with its contacts and its billing and shipping addresses, in one request.
• POSTCreate or update a customer by contact/v1/api/store/{team_slug}/customer/upsertFinds a customer by one contact's email or phone and updates it, or creates a new customer with that contact.
• GETList customers/v1/api/store/{team_slug}/customerLists the team's customers, without deleted and system customers.
• GETList a customer's tags/v1/api/store/{team_slug}/customer/{hash_id}/tagLists the tags on the customer, each with id, name and color_hex.
• GETList the users assigned to a customer/v1/api/store/{team_slug}/customer/{id}/assignLists the team members assigned to the customer.
• POSTSearch customers with filters/v1/api/store/{team_slug}/customer/filterLists customers that match every filter you send, sorted the way you ask.
• GETGet a customer/v1/api/store/{team_slug}/customer/{hash_id}Returns one customer, deleted ones included (trashed), with its contacts (deleted ones included), addresses (current and old copies), customer_profiles, assigned_users, tags and media.
• GETGet a customer's order counts and recent activity/v1/api/store/{team_slug}/customer/{hash_id}/activity_summaryCounts the customer's published sales orders, quotes and invoices, whatever their status (completed ones included), and lists its 10 newest sales orders and quotes.
• GETGet the QuickBooks customer linked to a customer/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}Reads the QuickBooks Online customer linked to this YoPrint customer, for the QuickBooks connection {id}.
• PUTUpdate a customer/v1/api/store/{team_slug}/customer/{hash_id}Changes the customer's own fields.
• PATCHUpdate a customer (PATCH)/v1/api/store/{team_slug}/customer/{hash_id}Changes the customer's own fields.
• PATCHSet a custom Customer Portal ID/v1/api/store/{team_slug}/customer/{hash_id}/customer_portal_token_overrideSets the Customer Portal ID shown for this customer (display_customer_portal_id) to a value you choose, and returns the customer with contacts.
• PUTLink a customer to a QuickBooks customer/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}Links this YoPrint customer to an existing QuickBooks Online customer, so YoPrint syncs it to that QuickBooks customer.
• PATCHRecalculate a customer's totals/v1/api/store/{team_slug}/customer/{hash_id}/recountRecalculates the customer's last_ordered_date, ordered_amount, unpaid_amount, deposit_due_amount, overdue_amount and quote_amount from its orders now, and returns the customer.
• PUTTag a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/attachPuts one of your team's tags on the customer and returns the customer's tags.
• PUTAssign or unassign a user on a customer/v1/api/store/{team_slug}/customer/{id}/assignAdds a team member to the customer's assigned users (action: assign) or removes one (action: unassign), and returns the assigned users.
• DELETEDelete a customer/v1/api/store/{team_slug}/customer/{hash_id}Deletes a customer.
• DELETERemove a custom Customer Portal ID/v1/api/store/{team_slug}/customer/{hash_id}/customer_portal_token_overrideClears the custom Customer Portal ID, so the generated one is shown again, and returns the customer with contacts.
• DELETEUnlink a customer from QuickBooks/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}Removes the link between this customer and its QuickBooks Online customer for the connection {id}.
• PUTRemove a tag from a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/detachTakes one tag off the customer and returns the customer's tags.
• PATCHRemove every tag from a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/detach_allTakes all tags off the customer and answers with an empty list.
• PATCHRestore a deleted customer/v1/api/store/{team_slug}/customer/{hash_id}/restoreBrings back a deleted customer.

Legacy and internal (1)

Prefer the operations above. Legacy operations name their replacement; internal ones are built for YoPrint's own apps.

• PATCHGet a customer portal sign-in tokenInternal/v1/api/store/{team_slug}/customer/{hash_id}/token_exchangeThis is a credential: don't log or share it.