imprint).
With the Designs API you can:
- List your company’s designs and search them by name
- Get a single design
- Rename a design
- Browse the products created from a design
The Design Object
Design Products
A design’s products are the branded items created from that design. They use the same Product shape asGET /v3/products, so you can reuse the same parsing for both. See Products for the full object.
Prices and availability depend on the location query parameter, which defaults to US.
Key Concepts & Business Rules
Account scoping
Every Design request requires theSnappy-Account-Id header. Designs are scoped to that account. An unknown account returns 404.
Design availability
Only designs that are ready are returned. A design that is still being generated is not listed, and responds with404 on get, rename and its product endpoints.
Sorting and filtering
Designs and design products are always returned newest first.sort is not supported.
The design list supports one filter:
filter[search]- case-insensitive search on the design name (1-100 characters)
400 on every Design endpoint.
Pagination
The list endpoints use page-number pagination (page[number], page[size]), and return links.first, links.next and links.prev:
See Request & Response Standards for the full V3 pagination contract.
Renaming a design
Onlyname can be changed. It is trimmed and must be 1-100 characters. Any other body field (for example imprint) returns 400. Design names are unique within the company: renaming a design to a name another design already uses returns 409.
Products of another design
Getting a product through a design only works for that design’s own products. A product that doesn’t exist, or that belongs to another design, returns404 with the same error code.
Permissions
How to Work with Designs
List designs404 if the design does not exist, and 409 if another design in the company already uses the name.
List the products of a design
include and fields options as GET /v3/products.
Get one product of a design
GET /v3/products/{productId}.