API reference

Every operation in YoPrint's public REST API, grouped by what it works on. Each page shows who may call it, its business rules and side effects, the request body, onecurl example, the response and the errors.

Base URL

https://secure.yoprint.com

Authentication

Authorization: Bearer YOUR_API_KEY

Paths

/v2/api/store/{team_slug}/… (153 operations) and /v1/api/store/{team_slug}/… (422)

Spec

Download the OpenAPI file (OpenAPI 3.1.0)

Sales

Sales orders

Sales orders and quotes: create a draft, add jobs and lines, publish it, then run actions on it.

• POSTCreate a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/new
• GETList the history of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/history
• POSTList sales orders/v2/api/store/{team_slug}/v2/sales_order/filter
• GETGet a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}
• PUTUpdate a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}
• PUTRun an action on a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/action/{action_name}
• PUTSet the Client Note of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/customer_note
• PUTSet the production note of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/production_note
• PATCHPublish a draft sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/publish
• DELETEDelete a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}
• PATCHRestore a deleted sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/restore
• POSTExport sales orders as CSV/v1/api/store/{team_slug}/sales_order/export
• POSTFilter sales orders (retired v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/filter
• GETGet an order's history (retired v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/history

Sales order line items

The lines of a sales order or quote: catalog products, your own products and their sizes and colors, custom lines and fees.

• POSTAdd a line item to a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item
• POSTAdd, change and delete line items in one save/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item/bulk
• GETList the line items of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item
• GETGet one line item/v2/api/store/{team_slug}/v2/sales_order/order_item/{order_item_unique_key}
• PUTUpdate a line item/v2/api/store/{team_slug}/v2/sales_order/order_item/{order_item_unique_key}
• DELETEDelete a line item/v2/api/store/{team_slug}/v2/sales_order/order_item/{order_item_unique_key}

Sales order approvals

Ask the customer to approve a whole sales order or quote, and record their answer.

• PUTRecord the customer's answer to an order approval/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}/complete
• GETList all approvals of an order, jobs included/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/all_approvals
• GETList the order approvals of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval
• GETGet an order approval/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}
• POSTAsk the customer to approve an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval
• PUTUpdate an order approval/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}
• DELETEDelete an order approval/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval/{hash_id2}

Sales order files

Files attached to a sales order or quote: the Files section in the web app.

• GETList the files of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media
• GETGet a file of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/{hash_id2}
• PUTAttach uploaded files to an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/attach
• DELETEDelete a file from an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/media/{hash_id2}

Sales order comments

Internal comments on a published sales order or quote.

• POSTAdd a comment to an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment
• GETList the comments of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/index
• GETGet a comment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}
• PUTEdit a comment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}
• DELETEDelete a comment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}
• PATCHRestore a deleted comment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/comment/{hash_id2}/restore

Sales order messages

The conversation with the customer on an order: its participants and the emails and text messages sent to them.

• POSTAdd a participant to an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant
• GETList the messages of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message
• GETList the participants of an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant
• POSTSend a message to the customer/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/message
• PATCHRemove every participant from an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant/clear
• GETList the messages of an order (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/message
• POSTSend a message to the customer (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/message

Sales order assignees

The team members in an order's Assigned To list.

• GETList the people assigned to an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user
• PUTAssign a team member to an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user/add
• PUTRemove a team member from an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/assign_user/remove

Sales order tags

Add and remove the team's tags on a sales order or quote.

• GETList the tags of an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag
• PUTTag an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach
• PUTRemove a tag from an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/detach

Sales order purchase orders

Purchase orders linked to a sales order, by the stock workflow or by hand.

• GETList the purchase orders linked to an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link
• PUTLink purchase orders to a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link/add
• PUTUnlink purchase orders from an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/purchase_order_link/remove

Quotes

Lists and exports for quotes only.

• POSTList quotes/v2/api/store/{team_slug}/v2/quote/filter
• POSTExport quotes as CSV/v1/api/store/{team_slug}/quote/export
• POSTFilter quotes (retired v1)Legacy · deprecated/v1/api/store/{team_slug}/quote/filter

Search

Quick lookups that return the first matches, for search boxes and pickers.

• GETSearch sales orders and quotes/v2/api/store/{team_slug}/search/orders
• POSTSearch sales orders and quotes/v2/api/store/{team_slug}/search/orders

Approvals

Every customer approval on your team, across all sales orders and quotes: artwork (job) approvals and whole-order approvals together, by approval id.

• GETList approvals/v1/api/store/{team_slug}/approvals
• POSTFilter approvals by type or status/v1/api/store/{team_slug}/approvals/filter
• GETGet the approvals on an approval's order/v1/api/store/{team_slug}/approvals/{hash_id}
• PATCHEmail an approval request to the customer/v1/api/store/{team_slug}/approvals/{hash_id}/send_to_customer
• DELETEDelete an approval/v1/api/store/{team_slug}/approvals/{hash_id}

Comments

Any internal comment by its id, whatever it is on: a sales order, a quote, a job or a purchase order.

• GETGet a comment/v1/api/store/{team_slug}/comment/{id}
• PUTEdit a comment/v1/api/store/{team_slug}/comment/{id}
• PATCHEdit a comment without checks/v1/api/store/{team_slug}/comment/{id}
• DELETEDelete a comment/v1/api/store/{team_slug}/comment/{id}
• PATCHRestore a deleted comment/v1/api/store/{team_slug}/comment/{hash_id}/restore

Document numbers

Preview the next sales order, quote, purchase order or stock adjustment number.

• GETPreview the next document number/v1/api/store/{team_slug}/available_identifier

Sales tax

Look up the automatic US sales tax rate for a shipping address.

• POSTLook up the automatic sales tax rate for an address/v1/api/store/{team_slug}/misc/calc_tax

Customers

Customers

The people and companies you sell to.

• POSTCreate a customer/v1/api/store/{team_slug}/customer
• POSTCreate or update a customer by contact/v1/api/store/{team_slug}/customer/upsert
• GETList customers/v1/api/store/{team_slug}/customer
• GETList a customer's tags/v1/api/store/{team_slug}/customer/{hash_id}/tag
• GETList the users assigned to a customer/v1/api/store/{team_slug}/customer/{id}/assign
• POSTSearch customers with filters/v1/api/store/{team_slug}/customer/filter
• GETGet a customer/v1/api/store/{team_slug}/customer/{hash_id}
• GETGet a customer's order counts and recent activity/v1/api/store/{team_slug}/customer/{hash_id}/activity_summary
• GETGet the QuickBooks customer linked to a customer/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}
• PUTUpdate a customer/v1/api/store/{team_slug}/customer/{hash_id}
• PATCHUpdate a customer (PATCH)/v1/api/store/{team_slug}/customer/{hash_id}
• PATCHSet a custom Customer Portal ID/v1/api/store/{team_slug}/customer/{hash_id}/customer_portal_token_override
• PUTLink a customer to a QuickBooks customer/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}
• PATCHRecalculate a customer's totals/v1/api/store/{team_slug}/customer/{hash_id}/recount
• PUTTag a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/attach
• PUTAssign or unassign a user on a customer/v1/api/store/{team_slug}/customer/{id}/assign
• DELETEDelete a customer/v1/api/store/{team_slug}/customer/{hash_id}
• DELETERemove a custom Customer Portal ID/v1/api/store/{team_slug}/customer/{hash_id}/customer_portal_token_override
• DELETEUnlink a customer from QuickBooks/v1/api/store/{team_slug}/customer/{hash_id}/external_id/{id}
• PUTRemove a tag from a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/detach
• PATCHRemove every tag from a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/detach_all
• PATCHRestore a deleted customer/v1/api/store/{team_slug}/customer/{hash_id}/restore
• PATCHGet a customer portal sign-in tokenInternal/v1/api/store/{team_slug}/customer/{hash_id}/token_exchange

Customer contacts

The people at a customer.

• POSTAdd a contact to a customer/v1/api/store/{team_slug}/customer/{hash_id}/contact
• POSTCreate or update a customer contact by email or phone/v1/api/store/{team_slug}/customer/{hash_id}/contact/upsert
• GETList a customer's contacts/v1/api/store/{team_slug}/customer/{hash_id}/contact
• GETGet a customer contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}
• PUTUpdate a customer contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}
• PATCHUpdate a customer contact (PATCH)/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}
• PATCHSet the primary contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}/primary
• DELETEDelete a customer contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}
• PATCHRestore a deleted customer contact/v1/api/store/{team_slug}/customer/{hash_id}/contact/{id}/restore

Customer addresses

A customer's billing and shipping addresses.

• POSTAdd an address to a customer/v1/api/store/{team_slug}/customer/{hash_id}/address
• GETList a customer's addresses/v1/api/store/{team_slug}/customer/{hash_id}/address
• GETGet a customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}
• PUTUpdate a customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}
• PATCHSet the primary address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/primary
• DELETEDelete a customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}
• PATCHRestore a deleted customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/restore

Customer brand profiles

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

• POSTCreate a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile
• GETList a customer's brand profiles/v1/api/store/{team_slug}/customer/{hash_id}/profile
• GETGet a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}
• PUTUpdate a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}
• PATCHUpdate a brand profile (same as PUT)/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}
• PATCHSet the primary brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}/primary
• DELETEDelete a brand profile/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}

Customer credit

Customer credit: money held for a customer, added or taken out by hand and used to pay their sales orders.

• POSTAdd or take out customer credit/v1/api/store/{team_slug}/customer/{hash_id}/credit
• GETList a customer's credit history/v1/api/store/{team_slug}/customer/{hash_id}/credit
• GETGet a customer credit entry/v1/api/store/{team_slug}/customer/{hash_id}/credit/{id}

Customer files

Files kept on a customer: tax exemption certificates, internal files and files the customer can see.

• GETList a customer's files/v1/api/store/{team_slug}/customer/{hash_id}/media
• GETList a customer's files in one collection/v1/api/store/{team_slug}/customer/{hash_id}/media/collection/{collection}
• GETGet a customer file/v1/api/store/{team_slug}/customer/{hash_id}/media/{id}
• POSTAttach uploaded files to a customer/v1/api/store/{team_slug}/customer/{hash_id}/media/attach
• DELETEDelete a customer file/v1/api/store/{team_slug}/customer/{hash_id}/media/{id}

Contacts

Any contact by its id, whether it belongs to a customer or a vendor.

• GETGet a contact by id/v1/api/store/{team_slug}/contact/{id}
• PUTUpdate a contact by id/v1/api/store/{team_slug}/contact/{id}
• PATCHUpdate a contact by id (PATCH)/v1/api/store/{team_slug}/contact/{id}
• DELETEDelete a contact by id/v1/api/store/{team_slug}/contact/{id}

Products and catalog

Products

Your own products.

• POSTCreate a product/v1/api/store/{team_slug}/product
• GETList all product brands/v1/api/store/{team_slug}/get_all_product_brands
• GETList all size names/v1/api/store/{team_slug}/get_all_product_sizes
• GETList products/v1/api/store/{team_slug}/product
• GETGet a product/v1/api/store/{team_slug}/product/{hash_id}
• POSTCheck whether a product can be deleted/v1/api/store/{team_slug}/product/{hash_id}/delete_check
• POSTLoad a product for a sales order line/v1/api/store/{team_slug}/hydrate_product
• PUTUpdate a product/v1/api/store/{team_slug}/product/{hash_id}
• PATCHUpdate a product (PATCH)/v1/api/store/{team_slug}/product/{hash_id}
• POSTPhase out a simple product/v1/api/store/{team_slug}/product/{hash_id}/phase_out
• POSTPut a phased-out simple product back on sale/v1/api/store/{team_slug}/product/{hash_id}/resume
• DELETEDelete a product/v1/api/store/{team_slug}/product/{hash_id}
• PATCHRestore a deleted product/v1/api/store/{team_slug}/product/{hash_id}/restore

Product variants

The size and color combinations of a variant product.

• POSTAdd a variant to a product/v1/api/store/{team_slug}/product/{hash_id}/variant
• GETList a product's variants/v1/api/store/{team_slug}/product/{hash_id}/variant
• GETGet a variant/v1/api/store/{team_slug}/product/{hash_id}/variant/{id}
• POSTCheck whether variants can be deleted/v1/api/store/{team_slug}/product/{hash_id}/variant/delete_check
• PUTUpdate a variant/v1/api/store/{team_slug}/product/{hash_id}/variant/{id}
• POSTPhase out variants (stop selling them)/v1/api/store/{team_slug}/product/{hash_id}/variant/phase_out
• POSTRename sizes and colors of a product/v1/api/store/{team_slug}/product/{hash_id}/variant/rename_options
• POSTPut phased-out variants back on sale/v1/api/store/{team_slug}/product/{hash_id}/variant/resume
• DELETEDelete a variant/v1/api/store/{team_slug}/product/{hash_id}/variant/{id}

Product stock

Your own stock levels for products, read-only.

• POSTGet stock levels for products/v1/api/store/{team_slug}/product_stock

Supplier catalog

Live prices, stock and images from your connected suppliers (S&S Activewear, SanMar, Momentec, AS Colour), for catalog products you sell on sales orders.

• POSTGet supplier images for catalog products/v1/api/store/{team_slug}/real_time_data_fetcher/images
• POSTGet live supplier inventory for catalog products/v1/api/store/{team_slug}/real_time_data_fetcher/inventory
• POSTGet live supplier pricing for catalog products/v1/api/store/{team_slug}/real_time_data_fetcher/pricing
• POSTGet live supplier pricing and inventory together/v1/api/store/{team_slug}/real_time_data_fetcher/pricing_with_inventory

Tags

Colored labels you put on customers and sales orders.

• POSTCreate a tag/v1/api/store/{team_slug}/tag
• GETList tags/v1/api/store/{team_slug}/tag
• POSTGet tags by id/v1/api/store/{team_slug}/tag/get_by_id
• PUTUpdate a tag/v1/api/store/{team_slug}/tag/{id}
• PATCHUpdate a tag (PATCH)/v1/api/store/{team_slug}/tag/{id}
• DELETEDelete a tag/v1/api/store/{team_slug}/tag/{id}

Purchasing

Purchase orders

Read one purchase order and change its status (two operations kept for the Zapier app), its history, the CSV export and the QuickBooks sync switch.

• GETList a purchase order's history/v1/api/store/{team_slug}/purchase_order/{hash_id}/history
• GETGet a purchase order/v1/api/store/{team_slug}/purchase_order/{hash_id}
• PUTChange a purchase order's status/v1/api/store/{team_slug}/purchase_order/{hash_id}/status
• PUTTurn QuickBooks sync on or off for purchase orders/v1/api/store/{team_slug}/purchase_order/bulk_action/mark_quickbook/{on_or_off}
• POSTExport purchase orders by issue date/v1/api/store/{team_slug}/purchase_order/export

Vendors

The suppliers you buy from.

• POSTCreate a vendor/v1/api/store/{team_slug}/vendor
• GETList vendors/v1/api/store/{team_slug}/vendor
• GETGet a vendor/v1/api/store/{team_slug}/vendor/{hash_id}
• GETGet the QuickBooks vendor linked to a vendor/v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}
• PUTUpdate a vendor/v1/api/store/{team_slug}/vendor/{hash_id}
• PATCHUpdate a vendor (PATCH)/v1/api/store/{team_slug}/vendor/{hash_id}
• PUTLink a vendor to a QuickBooks vendor/v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}
• DELETEDelete a vendor/v1/api/store/{team_slug}/vendor/{hash_id}
• DELETEUnlink a vendor from QuickBooks/v1/api/store/{team_slug}/vendor/{hash_id}/external_id/{id}
• PATCHRestore a deleted vendor/v1/api/store/{team_slug}/vendor/{hash_id}/restore

Vendor contacts

The people at a vendor.

• POSTAdd a contact to a vendor/v1/api/store/{team_slug}/vendor/{hash_id}/contact
• GETList a vendor's contacts/v1/api/store/{team_slug}/vendor/{hash_id}/contact
• GETGet a vendor contact/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}
• PUTUpdate a vendor contact/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}
• PATCHUpdate a vendor contact (PATCH)/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}
• PATCHSet a vendor's primary contact/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}/primary
• DELETEDelete a vendor contact/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}
• PATCHRestore a deleted vendor contact/v1/api/store/{team_slug}/vendor/{hash_id}/contact/{id}/restore

Vendor files

Files kept on a vendor, such as price lists.

• POSTUpload a file to a vendor/v1/api/store/{team_slug}/vendor/{hash_id}/media
• GETList a vendor's files/v1/api/store/{team_slug}/vendor/{hash_id}/media
• GETGet a vendor file/v1/api/store/{team_slug}/vendor/{hash_id}/media/{media_reference}
• POSTRename, reorder or delete vendor files/v1/api/store/{team_slug}/vendor/{hash_id}/media/{media_reference}
• DELETEDelete a vendor file/v1/api/store/{team_slug}/vendor/{hash_id}/media/{media_reference}

Production

Jobs

A job groups line items on a sales order or quote that are produced together, with their services (decorations), mockups, production files, tasks, dates and a status.

• POSTAdd a job to a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job
• POSTAdd a job from a job template/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job_template
• GETList the jobs of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job
• GETList jobs/v1/api/store/{team_slug}/job
• POSTList jobs in a date range/v1/api/store/{team_slug}/job/calendar
• POSTFilter jobs/v1/api/store/{team_slug}/job/filter
• GETGet one job of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/{job_id}
• PUTUpdate a job/v2/api/store/{team_slug}/v2/job/{hash_id}
• PUTCopy a job/v2/api/store/{team_slug}/v2/job/{hash_id}/clone
• PUTChange a job number/v2/api/store/{team_slug}/v2/job/{hash_id}/scoped_id
• PUTChange a job's status/v2/api/store/{team_slug}/v2/job/{hash_id}/status
• PUTSchedule a job/v2/api/store/{team_slug}/v2/job/{hash_id}/update_prod_date
• PUTReorder the jobs of a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/job/rearrange
• PUTAttach uploaded files to a job/v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/attach
• PUTReorder the files of a job/v1/api/store/{team_slug}/sales_order/{hash_id}/job/{id}/rearrange
• DELETEDelete a job/v2/api/store/{team_slug}/v2/job/{hash_id}
• POSTDownload small job labels (PDF)/v1/api/store/{team_slug}/job/export_dymo_label
• POSTDownload job details (PDF)/v1/api/store/{team_slug}/job/export_job_detail
• POSTDownload job details with mockups (PDF)/v1/api/store/{team_slug}/job/export_job_detail_mockup
• POSTDownload job labels (PDF)/v1/api/store/{team_slug}/job/export_job_label
• POSTDownload a job list (PDF)/v1/api/store/{team_slug}/job/export_job_list
• GETGet a job (retired)Legacy · deprecated/v1/api/store/{team_slug}/job/{hash_id}
• PUTChange a job's status (retired)Legacy · deprecated/v1/api/store/{team_slug}/job/{hash_id}/status

Tasks

Tasks are the production steps of a job (the work pipeline).

• POSTAdd a task to a job/v2/api/store/{team_slug}/v2/job/{hash_id}/work_pipeline
• GETList the tasks of a job/v2/api/store/{team_slug}/v2/job/{hash_id}/work_pipeline
• POSTList tasks in a date range/v1/api/store/{team_slug}/work_pipeline/calendar
• POSTFilter tasks/v1/api/store/{team_slug}/work_pipeline/filter
• GETGet a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}
• PUTUpdate a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}
• PUTAssign or unassign a person on a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}/assign
• PUTChange a task's status/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}/status
• POSTReorder tasks/v1/api/store/{team_slug}/work_pipeline/bulk_update_position
• DELETEDelete a task/v2/api/store/{team_slug}/v2/work_pipeline/{hash_id}

Barcodes

Turn a barcode or QR code printed by YoPrint into the record it points to.

• POSTDecode a YoPrint barcode/v1/api/store/{team_slug}/decode_barcode

Production control

The Production Control calendar: orders with their jobs and tasks over a date range.

• POSTRead the production control calendar/v1/api/store/{team_slug}/production_control/filter

Shipping

Shipments

Shipments send some or all of an order's lines to one address by one shipping type, with packages, labels and documents.

• POSTCreate a shipment for a sales order/v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment
• GETList the shipments of a sales order/v2/api/store/{team_slug}/v2/sales_order/{unique_key}/shipment
• POSTFilter shipments/v1/api/store/{team_slug}/shipment/filter
• PATCHCheck a shipment's address with the carrier/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/validate_address
• GETGet a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}
• PUTAssign or unassign a team member on a shipment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/assign
• PUTChange the status of a shipment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/{id}/status
• PUTUpdate a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}
• DELETEDelete a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}
• POSTDownload shipments as CSV/v1/api/store/{team_slug}/shipment/action/export_csv
• POSTDownload 4x6 shipment labels (PDF)/v1/api/store/{team_slug}/shipment/export_label
• POSTDownload letter-size shipment labels (PDF)/v1/api/store/{team_slug}/shipment/export_label_full
• POSTDownload packing slips (PDF)/v1/api/store/{team_slug}/shipment/export_packing_slip
• PATCHDelete all shipments of an order (retired)Legacy · deprecated/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/shipment/delete_all

Shipment line items

The lines of a shipment: quantities of order lines, and shipping cost lines.

• POSTAdd a line to a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item
• POSTAdd, change and remove shipment lines at once/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/bulk
• GETList the lines of a shipment/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item
• GETGet a shipment line/v2/api/store/{team_slug}/v2/shipment/item/{unique_key}
• POSTFix up shipment line positions/v2/api/store/{team_slug}/v2/shipment/{unique_key}/item/sort
• PUTUpdate a shipment line/v2/api/store/{team_slug}/v2/shipment/item/{unique_key}
• DELETERemove a line from a shipment/v2/api/store/{team_slug}/v2/shipment/item/{unique_key}

Shipment packages

The packages of a shipment: one per parcel of a label (a multi-parcel label makes several), with carrier, tracking number, size, weight, cost and status.

• GETList the packages of a shipment/v2/api/store/{team_slug}/v2/shipment/{hash_id}/packages
• POSTFilter packages/v1/api/store/{team_slug}/shipment_package/filter
• GETGet a package/v2/api/store/{team_slug}/v2/shipment_package/{hash_id}
• PATCHGet live tracking for a package/v1/api/store/{team_slug}/shipment_package/{id}/track
• PUTChange a package's status/v2/api/store/{team_slug}/v2/shipment_package/{hash_id}
• POSTChange and delete packages at once/v2/api/store/{team_slug}/v2/shipment/{unique_key}/package/bulk
• DELETEDelete a package (voids its label)/v2/api/store/{team_slug}/v2/shipment_package/{hash_id}

Shipping labels

Buying Shippo labels (this spends real money), recording labels bought elsewhere, and printing labels.

• POSTRecord a label bought elsewhere/v2/api/store/{team_slug}/v2/shipment/{hash_id}/label/external
• POSTBuy a shipping label (charges your Shippo account)Spends money/v2/api/store/{team_slug}/v2/shipment/{hash_id}/label/goshippo
• POSTDownload labels as one PDF/v2/api/store/{team_slug}/v2/shipment_package/labels/compile

Shipping rates and estimates

Shipping rates from your connected Shippo account, the carrier accounts behind them, and estimates (rate quotes saved on a shipment).

• POSTList Shippo carrier accounts/v2/api/store/{team_slug}/v2/carrier_account/goshippo
• GETList the shipping estimates of a shipment/v2/api/store/{team_slug}/v2/shipment/{hash_id}/estimates
• GETGet a shipping estimate/v2/api/store/{team_slug}/v2/shipment_estimate/{hash_id}
• POSTGet shipping rates/v2/api/store/{team_slug}/v2/shipment_rate/goshippo
• POSTSave a shipping estimate/v2/api/store/{team_slug}/v2/shipment/{hash_id}/shipment_estimate/goshippo
• DELETEDelete a shipping estimate/v2/api/store/{team_slug}/v2/shipment_estimate/{hash_id}

Invoices and payments

Invoices

Invoices bill some or all of a sales order or quote.

• POSTCreate an invoice for a sales order/v2/api/store/{team_slug}/v2/sales_order/{unique_key}/invoice
• POSTFilter invoices/v2/api/store/{team_slug}/v2/invoice/filter
• GETList the invoices of a sales order/v2/api/store/{team_slug}/v2/sales_order/{unique_key}/invoice
• POSTList invoice lines for export/v1/api/store/{team_slug}/sales_order/invoices/export_all_sales_order_invoice_item
• POSTList invoices for export/v1/api/store/{team_slug}/sales_order/invoices/export_list
• GETGet an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}
• PUTUpdate an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}
• PUTChange the tax on an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}/tax-selection
• DELETEDelete an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}
• POSTDownload invoices as one PDF/v1/api/store/{team_slug}/invoice/export_pdf
• POSTExport invoices as CSV/v1/api/store/{team_slug}/sales_order/invoices/export
• GETList invoices (v1)Legacy · deprecated/v1/api/store/{team_slug}/invoice
• GETGet an invoice (v1)Legacy · deprecated/v1/api/store/{team_slug}/invoice/{hash_id}
• PUTChange an invoice number (v1)Legacy · deprecated/v1/api/store/{team_slug}/invoice/{hash_id}
• PATCHChange an invoice number (v1) (same as PUT)Legacy · deprecated/v1/api/store/{team_slug}/invoice/{hash_id}

Invoice line items

The lines of an invoice: billed sales order lines, shipping fees, discounts and one tax line.

• POSTAdd a line to an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}/item
• POSTAdd, change and remove invoice lines at once/v2/api/store/{team_slug}/v2/invoice/{unique_key}/item/bulk
• GETList the lines of an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}/item
• GETGet an invoice line/v2/api/store/{team_slug}/v2/invoice/item/{unique_key}
• PUTUpdate an invoice line/v2/api/store/{team_slug}/v2/invoice/item/{unique_key}
• DELETERemove a line from an invoice/v2/api/store/{team_slug}/v2/invoice/item/{unique_key}

Payments

Payments, refunds and customer credit on a sales order: payments you record yourself, card payments through a connected gateway, and Square Terminal checkouts.

• POSTRecord a payment on a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment
• PUTRecord a refund of a payment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{id}/refund
• GETList the payments of a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment
• GETGet one payment of a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}
• POSTPay an order from the customer's credit/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/pay_with_customer_credit
• PATCHMove all of an order's payments to customer credit/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/refund_all_to_customer_credit
• POSTMove part of an order's payments to customer credit/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/credit/refund_to_customer_credit
• PUTRefund a card payment through the gateway/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_gateway_refund/{id}
• PUTUpdate a recorded payment/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}
• DELETEDelete a payment or refund/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}
• POSTStart a Square Terminal checkout (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/square_terminal/create
• POSTCheck a pending card payment (v1, not usable)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/poll_pending_payment
• PUTRefund a card payment (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/payment_gateway_refund/{id}
• POSTCharge a card through the gateway (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/payment/{payment_gateway}
• POSTPrepare a card payment (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/payment/{payment_gateway}/pre_execute
• PATCHCancel a Square Terminal checkout (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/square_terminal/{checkout_id}/cancel
• POSTStart a Square Terminal checkoutInternalMoves money/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/square_terminal/create
• POSTCheck a pending card payment (not usable)Internal/v2/api/store/{team_slug}/v2/sales_order/poll_pending_payment
• POSTPrepare a card paymentInternal/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_gateway}/pre_execute
• POSTCharge a card through the payment gatewayInternalMoves money/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment/{payment_reference}
• PATCHCancel a Square Terminal checkoutInternal/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/square_terminal/{checkout_id}/cancel

Payment links

A payment link records how payments received on a sales order are split across its invoices (the web app calls this a payment allocation).

• POSTCreate a payment link for a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link
• GETList the payment links of a sales order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link
• GETShow one payment link with allocations/v2/api/store/{team_slug}/v2/payment_link/{hash_id}
• GETGet the starting point for editing a payment link/v2/api/store/{team_slug}/v2/payment_link/{hash_id}/get_update_template
• GETGet what a new payment link can allocate/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/payment_link/get_create_template
• PUTUpdate a payment link/v2/api/store/{team_slug}/v2/payment_link/{hash_id}
• DELETEDelete a payment link/v2/api/store/{team_slug}/v2/payment_link/{hash_id}

Messages and activity

Messages

Your team's whole message inbox: emails and texts exchanged with customers and vendors on all sales orders, quotes and purchase orders, with their delivery status.

• GETList messages/v2/api/store/{team_slug}/messages
• GETList a message's recipients/v2/api/store/{team_slug}/messages/{hash_id}/recipients
• POSTFilter messages/v2/api/store/{team_slug}/messages/filter
• GETGet a message/v2/api/store/{team_slug}/messages/{hash_id}
• GETGet one recipient of a message/v2/api/store/{team_slug}/messages/{hash_id}/recipients/{id}
• PUTRetry delivery to one recipient/v2/api/store/{team_slug}/messages/{hash_id}/recipients/{id}/retry
• PUTRetry a message's failed deliveriesSpends money/v2/api/store/{team_slug}/messages/{hash_id}/retry
• PUTSet a message's status/v2/api/store/{team_slug}/messages/{hash_id}/status

Message participants

One person on an order's or purchase order's message thread, by participant id: who receives its customer emails and texts.

• GETGet a message participant/v1/api/store/{team_slug}/participant/{id}
• PUTChange a message participant/v1/api/store/{team_slug}/participant/{id}
• PATCHChange a message participant without checks/v1/api/store/{team_slug}/participant/{id}
• DELETERemove a message participant/v1/api/store/{team_slug}/participant/{id}

Notifications

Your own notification feed: the YoPrint activity that concerns you, such as new comments, customer replies, payments and approvals.

• GETList your notifications/v1/api/store/{team_slug}/current_user_feed
• PUTArchive notifications/v1/api/store/{team_slug}/current_user_feed/archive
• PUTArchive all your notifications/v1/api/store/{team_slug}/current_user_feed/mark_all_as_archive
• PUTMark all your notifications as seen/v1/api/store/{team_slug}/current_user_feed/mark_all_as_seen
• PUTMark notifications as seen/v1/api/store/{team_slug}/current_user_feed/seen
• PUTUnarchive notifications/v1/api/store/{team_slug}/current_user_feed/unarchive
• PUTMark notifications as not seen/v1/api/store/{team_slug}/current_user_feed/unseen

Your preferences

Your saved web app preferences for one team, such as grid column layouts.

• GETGet your preferences for this team/v1/api/store/{team_slug}/current_user_preference
• POSTSave your preferences for this team/v1/api/store/{team_slug}/current_user_preference

Imports and exports

Data exports

Whole-team CSV exports from the Download Center: customers, products, sales orders, invoices, payments, tax and purchase orders.

• GETList data exports/v1/api/store/{team_slug}/data_export
• GETList export types and their columns/v1/api/store/{team_slug}/data_export/definitions
• GETList export column presets/v1/api/store/{team_slug}/data_export/presets
• GETGet a data export/v1/api/store/{team_slug}/data_export/{id}
• POSTSave an export column preset/v1/api/store/{team_slug}/data_export/presets
• DELETEDelete an export column preset/v1/api/store/{team_slug}/data_export/presets/{presetId}
• GETDownload a data export's file/v1/api/store/{team_slug}/data_export/{id}/download
• POSTExport all customers to CSV/v1/api/store/{team_slug}/data_export/export_customer
• POSTExport invoices in a date range to CSV/v1/api/store/{team_slug}/data_export/export_invoice
• POSTExport invoice line items in a date range to CSV/v1/api/store/{team_slug}/data_export/export_invoice_item
• POSTExport payments and refunds in a date range to CSV/v1/api/store/{team_slug}/data_export/export_payment_list
• POSTExport purchase orders in a date range to CSV/v1/api/store/{team_slug}/data_export/export_purchase_order_list
• POSTExport sales orders in a date range to CSV/v1/api/store/{team_slug}/data_export/export_sales_order
• POSTExport all simple products to CSV/v1/api/store/{team_slug}/data_export/export_simple_product_list
• POSTExport the tax report for a date range to CSV/v1/api/store/{team_slug}/data_export/export_tax
• POSTExport all variant products to CSV/v1/api/store/{team_slug}/data_export/export_variant_product_list

CSV imports

CSV templates, the service pricing CSV upload, and your import jobs.

• POSTImport a service's price table from CSV/v1/api/store/{team_slug}/imports/csv
• GETList import jobs/v1/api/store/{team_slug}/imports
• GETList import activity/v1/api/store/{team_slug}/source-imports/activity
• GETGet an import job/v1/api/store/{team_slug}/imports/{hash_id}
• PUTDownload the customer CSV template/v1/api/store/{team_slug}/csv/template/customer
• PUTDownload the service pricing CSV template/v1/api/store/{team_slug}/csv/template/service_pricing
• PUTDownload the simple product CSV template/v1/api/store/{team_slug}/csv/template/simple_product
• PUTDownload the variant product CSV template/v1/api/store/{team_slug}/csv/template/variant_product
• PUTDownload the vendor CSV template/v1/api/store/{team_slug}/csv/template/vendor
• GETDownload an import job's failed rows/v1/api/store/{team_slug}/imports/{hash_id}/artifacts/error-csv

Uploads

Upload a file first, then attach it to a job, an order, a purchase order or a customer by its id.

• POSTUpload a file/v1/api/store/{team_slug}/async_upload
• GETGet an uploaded file/v1/api/store/{team_slug}/async_upload/{hash_id}
• PUTSet an uploaded file's location or mockup flag/v1/api/store/{team_slug}/async_upload/{hash_id}
• PATCHSet an uploaded file's location or mockup flag with PATCH/v1/api/store/{team_slug}/async_upload/{hash_id}
• DELETEDelete an uploaded file/v1/api/store/{team_slug}/async_upload/{hash_id}

Reports

Reports

Period reports of orders, purchase orders, payments and paid invoices, for your own reporting.

• POSTReport payments and refunds/v1/api/store/{team_slug}/report/payment
• POSTReport purchase orders by issue date/v1/api/store/{team_slug}/report/purchase_order
• POSTReport quotes by issue date/v1/api/store/{team_slug}/report/quote
• POSTReport sales orders by issue date/v1/api/store/{team_slug}/report/sales_order
• POSTReport invoices of orders paid in full/v1/api/store/{team_slug}/report/tax

Team settings

Webhook subscriptions

Subscribe a URL to YoPrint events, such as a published sales order or a received payment.

• POSTCreate a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription
• GETList webhook subscriptions/v1/api/store/{team_slug}/setting/webhook_subscription
• GETList deliveries for a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{id}/log
• GETShow a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}
• GETShow a sample event/v1/api/store/{team_slug}/setting/webhook_subscription/sample/{event_name}
• PUTUpdate a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}
• PATCHTouch a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}
• DELETEDelete a webhook subscription/v1/api/store/{team_slug}/setting/webhook_subscription/{hash_id}

Statuses

The status lists for sales orders, quotes, jobs, purchase orders, shipments, message threads and task presets.

• POSTCreate a status/v1/api/store/{team_slug}/setting/status
• GETList every status, including deleted ones/v1/api/store/{team_slug}/setting/status
• GETList message thread statuses/v1/api/store/{team_slug}/setting/status/customer_message
• GETList job statuses/v1/api/store/{team_slug}/setting/status/job
• GETList the task statuses of a task preset/v1/api/store/{team_slug}/setting/status/pipeline/{hash_id}
• GETList purchase order statuses/v1/api/store/{team_slug}/setting/status/purchase_order
• GETList purchase order statuses, without the ending one/v1/api/store/{team_slug}/setting/status/purchase_order_without_end
• GETList quote statuses/v1/api/store/{team_slug}/setting/status/quote
• GETList sales order statuses/v1/api/store/{team_slug}/setting/status/sales_order
• GETList shipment statuses/v1/api/store/{team_slug}/setting/status/shipment
• GETGet a status/v1/api/store/{team_slug}/setting/status/{status_reference}
• POSTSave a set of status changes/v1/api/store/{team_slug}/setting/status/{status_reference}
• PUTUpdate a status/v1/api/store/{team_slug}/setting/status/{status_reference}
• PATCHUpdate a status without checks/v1/api/store/{team_slug}/setting/status/{status_reference}
• DELETEDelete a status/v1/api/store/{team_slug}/setting/status/{status_reference}
• PATCHRestore a deleted status/v1/api/store/{team_slug}/setting/status/{id}/restore

Team members

The people on your team, their permission groups, and ownership.

• GETList team members/v1/api/store/{team_slug}/setting/user
• GETGet a team member/v1/api/store/{team_slug}/setting/user/{hash_id}
• POSTTransfer team ownership/v1/api/store/{team_slug}/setting/user/{hash_id}/make_owner
• DELETERemove a member from the team/v1/api/store/{team_slug}/setting/user/{hash_id}

Company locations

The team's own addresses: the primary location, warehouses, the default warehouse and tax nexus.

• POSTCreate a company location/v1/api/store/{team_slug}/setting/location
• GETList company locations/v1/api/store/{team_slug}/setting/location
• GETShow a company location/v1/api/store/{team_slug}/setting/location/{hash_id}
• PUTUpdate a company location/v1/api/store/{team_slug}/setting/location/{hash_id}
• PATCHUpdate a company location without checks/v1/api/store/{team_slug}/setting/location/{hash_id}
• PATCHSet the default warehouse/v1/api/store/{team_slug}/setting/location/{id}/default_warehouse
• PATCHSet a location as a warehouse/v1/api/store/{team_slug}/setting/location/{id}/hold_stock
• PATCHSet the primary location/v1/api/store/{team_slug}/setting/location/{id}/primary
• DELETEDelete a company location/v1/api/store/{team_slug}/setting/location/{hash_id}
• PATCHRestore a company location/v1/api/store/{team_slug}/setting/location/{id}/restore

Company settings

Your company's profile, logo, customer portal look, custom domain, general preferences and list columns.

• POSTUpload the customer portal background/v1/api/store/{team_slug}/setting/customer_portal_bg
• POSTUpload the customer portal favicon/v1/api/store/{team_slug}/setting/customer_portal_favicon
• POSTUpload the team logo/v1/api/store/{team_slug}/setting/photo
• GETShow team settings/v1/api/store/{team_slug}/setting
• PUTCheck a custom domain is allowed/v1/api/store/{team_slug}/setting/custom_domain/check
• PUTCheck a custom domain's DNS/v1/api/store/{team_slug}/setting/custom_domain/check_setup
• GETGet your company details/v1/api/store/{team_slug}/setting/detail
• PUTUpdate company details/v1/api/store/{team_slug}/setting
• PUTSet the columns of a list/v1/api/store/{team_slug}/setting/column
• PUTSet the custom domain/v1/api/store/{team_slug}/setting/custom_domain/update
• PUTUpdate general settings/v1/api/store/{team_slug}/setting/general
• DELETERemove the customer portal background/v1/api/store/{team_slug}/setting/customer_portal_bg
• DELETERemove the customer portal favicon/v1/api/store/{team_slug}/setting/customer_portal_favicon
• DELETERemove the team logo/v1/api/store/{team_slug}/setting/photo

Compliance requests

Files produced for privacy requests, such as a Shopify customer data request.

• GETDownload a Shopify customer data exportInternal/v1/api/store/{team_slug}/setting/compliance/shopify-data-request/{id}/download

Connected devices

Card terminals paired with your team.

• GETList connected devices/v1/api/store/{team_slug}/setting/connected_device
• DELETERemove a connected device/v1/api/store/{team_slug}/setting/connected_device/{hash_id}

Currencies

The team's currencies.

• POSTCreate a currency/v1/api/store/{team_slug}/setting/currency
• GETList currencies/v1/api/store/{team_slug}/setting/currency
• GETShow a currency/v1/api/store/{team_slug}/setting/currency/{hash_id}
• PUTUpdate a currency/v1/api/store/{team_slug}/setting/currency/{hash_id}
• PATCHUpdate a currency without checks/v1/api/store/{team_slug}/setting/currency/{hash_id}
• DELETEDelete a currency/v1/api/store/{team_slug}/setting/currency/{hash_id}
• PATCHRestore a currency/v1/api/store/{team_slug}/setting/currency/{id}/restore

Feature add-ons

Optional features a team turns on or off.

• PUTTurn off a feature add-on/v1/api/store/{team_slug}/setting/feature_addon/{module}/disable
• PUTTurn on a feature add-on/v1/api/store/{team_slug}/setting/feature_addon/{module}/enable

Fee presets

Saved fee names and prices to copy into fee line items.

• POSTCreate a fee preset/v1/api/store/{team_slug}/setting/fee_preset
• GETList fee presets/v1/api/store/{team_slug}/setting/fee_preset
• POSTSearch fee presets by name/v1/api/store/{team_slug}/setting/fee_preset/search
• GETShow a fee preset/v1/api/store/{team_slug}/setting/fee_preset/{hash_id}
• PUTUpdate a fee preset/v1/api/store/{team_slug}/setting/fee_preset/{hash_id}
• PATCHUpdate a fee preset without checks/v1/api/store/{team_slug}/setting/fee_preset/{hash_id}
• DELETEDelete a fee preset/v1/api/store/{team_slug}/setting/fee_preset/{hash_id}

Integration logs

Recent QuickBooks Online and Shopify sync errors for one sales order, purchase order or shipment.

• GETList a sales order's integration errors/v1/api/store/{team_slug}/external_integration_logs/order/{hash_id}
• GETList a purchase order's integration errors/v1/api/store/{team_slug}/external_integration_logs/purchase_order/{hash_id}
• GETList a shipment's integration errors/v1/api/store/{team_slug}/external_integration_logs/shipment/{hash_id}

Integrations

Connections to suppliers, Twilio, GoShippo, QuickBooks Online, Square and Shopify.

• GETList integrations/v1/api/store/{team_slug}/setting/external_integration
• GETList an integration's error log/v1/api/store/{team_slug}/setting/external_integration/{id}/logs
• POSTSearch integrations/v1/api/store/{team_slug}/setting/external_integration/filter
• GETGet an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• PUTRead data from an integration's provider/v1/api/store/{team_slug}/setting/external_integration/{id}/data
• POSTConnect an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• PUTUpdate an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• PATCHUpdate an integration (same as PUT)/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• DELETEDisconnect an integration/v1/api/store/{team_slug}/setting/external_integration/{external_integration_reference}
• PUTRun an integration action/v1/api/store/{team_slug}/setting/external_integration/{id}/action
• PATCHRestore a removed Shopify store/v1/api/store/{team_slug}/setting/external_integration/{id}/restore
• PUTSearch QuickBooks, or sync records to itInternal/v1/api/store/{team_slug}/setting/external_integration/{id}/public_action
• PUTRead Shopify orders through the integrationInternal/v1/api/store/{team_slug}/setting/external_integration/{id}/proxy_request
• POSTCheck a Shopify install signatureInternal/v1/api/store/{team_slug}/setting/external_integration/shopify/verify-signature
• PATCHRetry a logged integration errorInternal/v1/api/store/{team_slug}/setting/external_integration/retry_action/{id}
• POSTFinish a Shopify installInternal/v1/api/store/{team_slug}/setting/external_integration/shopify/finalize-install

Job presets

Ready-made jobs, with their services, tasks, people and files, that you add to a sales order or quote in one step.

• POSTCreate a job preset/v1/api/store/{team_slug}/setting/job_preset
• GETList job presets/v1/api/store/{team_slug}/setting/job_preset
• POSTSearch job presets by name/v1/api/store/{team_slug}/setting/job_preset/search
• GETGet a job preset/v1/api/store/{team_slug}/setting/job_preset/{hash_id}
• PUTUpdate a job preset/v1/api/store/{team_slug}/setting/job_preset/{hash_id}
• PATCHTouch a job preset/v1/api/store/{team_slug}/setting/job_preset/{hash_id}
• POSTDuplicate a job preset/v1/api/store/{team_slug}/setting/job_preset/{hash_id}/duplicate
• PUTReorder job presets/v1/api/store/{team_slug}/setting/job_preset/arrange
• DELETEDelete a job preset/v1/api/store/{team_slug}/setting/job_preset/{hash_id}

Message template attachments

The files a message template attaches when it is sent: document PDFs, job sheets, invoices or an uploaded file.

• POSTAdd an attachment to a template/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment
• GETList a template's attachments/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment
• GETGet a template attachment/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}
• PUTUpdate a template attachment/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}
• PATCHChange a template attachment with PATCH/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}
• DELETERemove a template attachment/v2/api/store/{team_slug}/setting/message_template/{hash_id}/internal_attachment/{id}

Message templates

Reusable email and text messages for sales orders, quotes and purchase orders, with placeholders and attachments.

• POSTCreate a message template/v2/api/store/{team_slug}/setting/message_template
• GETList message templates/v2/api/store/{team_slug}/setting/message_template
• GETList message template types/v2/api/store/{team_slug}/setting/message_template/config
• GETGet a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}
• GETGet a message template type/v2/api/store/{team_slug}/setting/message_template/config/{type}
• POSTPreview template text/v2/api/store/{team_slug}/setting/message_template/preview
• PUTUpdate a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}
• PATCHTouch a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}
• POSTFill in a template for a record/v2/api/store/{team_slug}/setting/message_template/compile
• POSTSend a template for a recordSpends money/v2/api/store/{team_slug}/setting/message_template/send
• DELETEDelete a message template/v2/api/store/{team_slug}/setting/message_template/{hash_id}

Payment gateways

Card payment gateway credentials: Stripe, PayPal, Square, Charge It Pro and Authorize.Net.

• PUTList Square locations/v1/api/store/{team_slug}/setting/payment_gateway/get_square_location_list
• PUTUpdate payment gateway settings/v1/api/store/{team_slug}/setting/payment_gateway

Payment methods

Labels for payments you record yourself, such as Cash or Check.

• POSTCreate a payment method/v1/api/store/{team_slug}/setting/payment_method
• GETList payment methods/v1/api/store/{team_slug}/setting/payment_method
• GETShow a payment method/v1/api/store/{team_slug}/setting/payment_method/{hash_id}
• PUTUpdate a payment method/v1/api/store/{team_slug}/setting/payment_method/{hash_id}
• PATCHUpdate a payment method without checks/v1/api/store/{team_slug}/setting/payment_method/{hash_id}
• DELETEDelete a payment method/v1/api/store/{team_slug}/setting/payment_method/{hash_id}
• PATCHRestore a payment method/v1/api/store/{team_slug}/setting/payment_method/{id}/restore

Payment terms

Deposit and due-date rules that new sales orders and quotes copy from the customer or the team default.

• POSTCreate a payment term/v1/api/store/{team_slug}/setting/payment_term
• GETList payment terms/v1/api/store/{team_slug}/setting/payment_term
• GETShow a payment term/v1/api/store/{team_slug}/setting/payment_term/{hash_id}
• PUTUpdate a payment term/v1/api/store/{team_slug}/setting/payment_term/{hash_id}
• PATCHUpdate a payment term without checks/v1/api/store/{team_slug}/setting/payment_term/{hash_id}
• PATCHSet the default payment term/v1/api/store/{team_slug}/setting/payment_term/{id}/default
• DELETEDelete a payment term/v1/api/store/{team_slug}/setting/payment_term/{hash_id}
• PATCHRestore a payment term/v1/api/store/{team_slug}/setting/payment_term/{id}/restore

Permission groups

What members can do.

• POSTCreate a permission group/v1/api/store/{team_slug}/setting/group
• GETList permission groups/v1/api/store/{team_slug}/setting/group
• GETShow a permission group/v1/api/store/{team_slug}/setting/group/{hash_id}
• PUTUpdate a permission group/v1/api/store/{team_slug}/setting/group/{hash_id}
• PATCHTouch a permission group/v1/api/store/{team_slug}/setting/group/{hash_id}
• PATCHMove a member to a permission group/v1/api/store/{team_slug}/setting/group/{id}/change_user_group
• DELETEDelete a permission group/v1/api/store/{team_slug}/setting/group/{hash_id}

Running numbers

The next sales order, purchase order and invoice numbers.

• GETShow the next document numbers/v1/api/store/{team_slug}/setting/running_number
• PUTSet the next document numbers/v1/api/store/{team_slug}/setting/running_number

Service locations

Where on an item a decoration goes, such as "Shirt - Front".

• POSTCreate a service location/v1/api/store/{team_slug}/service_location
• GETList service locations/v1/api/store/{team_slug}/service_location
• GETGet a service location/v1/api/store/{team_slug}/service_location/{hash_id}
• PUTUpdate a service location/v1/api/store/{team_slug}/service_location/{hash_id}
• PATCHUpdate a service location (PATCH)/v1/api/store/{team_slug}/service_location/{hash_id}
• DELETEDelete a service location/v1/api/store/{team_slug}/service_location/{hash_id}
• PATCHRestore a service location/v1/api/store/{team_slug}/service_location/{hash_id}/restore

Shipping boxes

Saved box sizes for GoShippo parcels.

• POSTCreate a shipping box/v1/api/store/{team_slug}/setting/shipment_box
• GETList shipping boxes/v1/api/store/{team_slug}/setting/shipment_box
• GETShow a shipping box/v1/api/store/{team_slug}/setting/shipment_box/{hash_id}
• PUTUpdate a shipping box/v1/api/store/{team_slug}/setting/shipment_box/{hash_id}
• PATCHMake a shipping box the default/v1/api/store/{team_slug}/setting/shipment_box/{hash_id}
• DELETEDelete a shipping box/v1/api/store/{team_slug}/setting/shipment_box/{hash_id}

Shipping methods

How shipments go out: courier, own delivery, pick-up or a carrier integration service.

• POSTCreate a shipping method/v1/api/store/{team_slug}/setting/shipping_type
• GETList shipping methods/v1/api/store/{team_slug}/setting/shipping_type
• GETShow a shipping method/v1/api/store/{team_slug}/setting/shipping_type/{hash_id}
• PUTUpdate a shipping method/v1/api/store/{team_slug}/setting/shipping_type/{hash_id}
• PATCHMake a shipping method the default/v1/api/store/{team_slug}/setting/shipping_type/{hash_id}
• DELETEDelete a shipping method/v1/api/store/{team_slug}/setting/shipping_type/{hash_id}
• PATCHRestore a shipping method/v1/api/store/{team_slug}/setting/shipping_type/{id}/restore

Stock adjustment reasons

The reasons offered when stock is adjusted by hand.

• POSTCreate a stock adjustment reason/v1/api/store/{team_slug}/setting/adjustment_reason
• GETList stock adjustment reasons/v1/api/store/{team_slug}/setting/adjustment_reason
• GETShow a stock adjustment reason/v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}
• PUTUpdate a stock adjustment reason/v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}
• PATCHUpdate a stock adjustment reason without checks/v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}
• DELETEDelete a stock adjustment reason/v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}

Task presets

Named sets of task statuses (pipelines in the API) that tasks on jobs follow.

• POSTCreate a task preset/v1/api/store/{team_slug}/setting/pipeline
• GETList task presets/v1/api/store/{team_slug}/setting/pipeline
• GETShow a task preset/v1/api/store/{team_slug}/setting/pipeline/{hash_id}
• PUTUpdate a task preset/v1/api/store/{team_slug}/setting/pipeline/{hash_id}
• PATCHUpdate a task preset without checks/v1/api/store/{team_slug}/setting/pipeline/{hash_id}
• DELETEDelete a task preset/v1/api/store/{team_slug}/setting/pipeline/{hash_id}
• PATCHRestore a task preset/v1/api/store/{team_slug}/setting/pipeline/{id}/restore

Tax presets

The taxes you apply to invoices: one rate, or named parts that add up, plus YoPrint's Auto Tax.

• POSTCreate a tax preset/v1/api/store/{team_slug}/setting/tax_type
• GETList tax presets/v1/api/store/{team_slug}/setting/tax_type
• GETShow a tax preset/v1/api/store/{team_slug}/setting/tax_type/{hash_id}
• PUTUpdate a tax preset/v1/api/store/{team_slug}/setting/tax_type/{hash_id}
• PATCHUpdate a tax preset (same as PUT)/v1/api/store/{team_slug}/setting/tax_type/{hash_id}
• DELETEDelete a tax preset/v1/api/store/{team_slug}/setting/tax_type/{hash_id}
• PATCHRestore a tax preset/v1/api/store/{team_slug}/setting/tax_type/{id}/restore

Team invitations

Email invitations to join your team, with the permission group the person gets.

• GETList invitations/v1/api/store/{team_slug}/setting/invite
• POSTInvite someone to the team/v1/api/store/{team_slug}/setting/invite
• PUTChange an invitation's permission group/v1/api/store/{team_slug}/setting/invite/{invite}
• PATCHChange an invitation with PATCH/v1/api/store/{team_slug}/setting/invite/{invite}
• PATCHResend an invitation/v1/api/store/{team_slug}/setting/invite/resend/{invite}
• DELETEDelete an invitation/v1/api/store/{team_slug}/setting/invite/{invite}

YoPrint subscription

Your shop's own YoPrint plan and billing: plans, checkout, card, invoices, cancellation and the billing operations that track each change.

• GETList your YoPrint invoices/v1/api/store/{team_slug}/setting/subscription/invoice
• GETList YoPrint plans you can choose/v1/api/store/{team_slug}/setting/subscription/plan
• PUTCheck a YoPrint coupon/v1/api/store/{team_slug}/setting/subscription/check_coupon
• GETGet your YoPrint subscription/v1/api/store/{team_slug}/setting/subscription/current
• GETCheck a failed YoPrint payment before retrying/v1/api/store/{team_slug}/setting/subscription/current/retry_payment_preview
• GETGet a YoPrint billing operation/v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}
• GETGet the unfinished YoPrint billing operation/v1/api/store/{team_slug}/setting/subscription/operation/current
• PUTPreview a YoPrint plan change/v1/api/store/{team_slug}/setting/subscription/plan/preview
• PATCHResume your YoPrint subscription/v1/api/store/{team_slug}/setting/subscription/current/resume
• POSTRetry a failed YoPrint payment/v1/api/store/{team_slug}/setting/subscription/current/retry_payment
• PUTReplace the card for your YoPrint subscription/v1/api/store/{team_slug}/setting/subscription/current/update_card
• POSTRecover a YoPrint billing operation/v1/api/store/{team_slug}/setting/subscription/operation/{operation_id}/recover
• POSTSubscribe to or change your YoPrint plan/v1/api/store/{team_slug}/setting/subscription/plan/checkout
• POSTChoose the plan for your free trial/v1/api/store/{team_slug}/setting/subscription/plan/select_trial
• PATCHCancel your YoPrint subscription/v1/api/store/{team_slug}/setting/subscription/current/cancel
• GETGet a link to the billing pageInternal/v1/api/store/{team_slug}/setting/billing_portal

Account

API key

Your personal API key.

• POSTCreate your personal API key (refused on the public API)/v1/api/store/{team_slug}/user_api_key/create_api_key
• GETCheck that your API key works for a team/v1/api/store/{team_slug}/is_authenticated
• GETShow your personal API key (refused on the public API)/v1/api/store/{team_slug}/user_api_key/get_api_key
• POSTReplace your personal API key (refused on the public API)/v1/api/store/{team_slug}/user_api_key/reset_api_key