/carts

post

Create a Shopping Cart

get

Returns the details to this cart

patch

Update the specification of this cart.

delete

Delete this cart instance.

get

Returns all possible validation errors, determining if this cart can be checked out, in the sense that a POST request to checkout will succeed.

post

Perform a checkout on the cart, actually placing the order

get

Returns the details for the current cart's customer.

post

Sets the customer for the current cart.

delete

Delete the customer information for the current cart.

get

Returns the details for the current cart's recipient, which is the person receiving the order's delivery, which again is separate from the address to which the printed product of the order will be delivered (see delivery_address endpoints for that). Beware that a recipient can only be set AFTER a customer has been set.

post

Sets the recipient for the current cart.

delete

Delete the recipient information for the current cart.

get

Returns the details for the current cart's carrier definition. A carrier basically defines which shipping carrier will transport the printed products of the current cart to it's delivery address. In most cases this will be some carrier such as 'DHL' or 'UPS', but it's essentially totally up to the printeries discretion which carriers it uses and defines.

post

Set the current cart's carrier definition

delete

Delete the current cart's carrier definition

get

Fetch all products, currently added to this cart.

post

Add a printed product to this cart. Note that the Inbox API only allows to add instances of predefined products (a ProductTemplate in Keyline terminology) to a cart. Those products however can be further customized within certain boundaries.

get

Fetch details of a single product, that's been added to this cart.

patch

Update the specification of this specific product in the cart.

delete

Remove this one product from the cart.

get

Get details about all variants for the given product.

post

Create a new variant for the given product.

get

Get details about a single variant for the given product.

patch

Update a variant for the given product.

delete

Delete a variant for the given product.

get

Fetch information for all print data files for the given product

post

Create a new print data file for the given product

get

Fetch details for a single print data file

patch

Update the given print data file

delete

Delete the given print data file information

get

Fetch details of a all components of a product.

get

Fetch details of a particular component of this product.

patch

Update the specification of a particular component of this product.

get

Fetch information for all print data files for the given component

post

Create a new print data file for the given component

get

Fetch details for a single print data file related to the given component

patch

Update the given print data file

delete

Delete the given print data file information

get

Show the billing address set for this cart

post

Set the billing address for this cart.

delete

Delete the billing address associated with this cart

get

Show the delivery address set for this cart

post

Set the delivery address for this cart.

delete

Delete the delivery address associated with this cart

/orders

get

Fetch Details and state of a specific order, including details for all products

delete

Cancel the order. This might fail with this status code 422, if the order cannot be canceled anymore, because is already being printed or due to other reasons.

get

Fetch all products that make up this order

get

Fetch details of a single product, that's part of this order.

get

Fetch information for all print data files for the given product

post

Create a new print data file for the given product

get

Fetch details for a single print data file

patch

Update the given print data file

delete

Delete the given print data file information

get

Fetch details of a all components of a product.

get

Fetch details of a particular component of the given product.

get

Fetch information for all print data files for the given component

post

Create a new print data file for the given component

get

Fetch details for a single print data file related to the given component

patch

Update the given print data file

delete

Delete the given print data file information

get

Returns the details for the current order's carrier definition. A carrier basically defines which shipping carrier will transport the printed products of the current cart to it's delivery address. In most cases this will be some carrier such as 'DHL' or 'UPS', but it's essentially totally up to the printeries discretion which carriers it uses and defines.

post

Set the current cart's carrier definition

delete

Delete the current order's carrier definition

get

Show the delivery address set for this order

post

Set the delivery address for this order.

delete

Delete the delivery address associated with this order