Skip to content

Customer brand profiles

Open .md

API reference Customers Customers

Brand Profiles: the company name, logo, contact details and Ship From address printed on a customer's documents and used on its shipments.

7 operations

  • POSTCreate a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profileCreates a brand profile for the customer and returns it.
  • GETList a customer's brand profiles/v1/api/store/{team_slug}/customer/{hash_id}/profileLists the customer's brand profiles, deleted ones included (trashed).
  • GETGet a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}Returns one live brand profile of the customer.
  • PUTUpdate a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}Changes the fields you send and returns the profile.
  • PATCHUpdate a brand profile (same as PUT)/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}Changes the fields you send and returns the profile.
  • PATCHSet the primary brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}/primaryMakes this profile the customer's primary brand profile, the one new sales orders and quotes use.
  • DELETEDelete a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}Deletes a brand profile.