Appearance
Print API — Requests from Canva
Overview
To create and update orders on the print partner's system, Canva sends requests to the print partner's service. To facilitate this, the print partner must implement their side of the Print API and provide endpoints for Canva to access.
API endpoints
The print partner must provide the following endpoints for Canva to access:
- Create order
- Get order
- Update order
- Cancel order
- Find locations
Request verification
When print partners receive a request, they must verify the request came from Canva. Only Canva is authorized to send create and update Canva print orders.
Canva signs all requests with cryptographic keys using a JSON Web Key Set (JWKS). Each request includes a signature in a header named X-Canva-Signature.
Canva provides the Get signing keys endpoint for print partners to get Canva's Ed25519 public keys to verify the request signature.
The request verification process is as follows:
Retrieve Canva's public keys from the Get signing keys endpoint.
Verify the signature of each incoming request to your Print API endpoints, using Canva's public keys.
Check the following claims in the signature payload:
iss(issuer): This must beCanva.aud(audience): This must match your OAuth client ID.sub(subject): This must match your print client ID.order(order): This must match the order ID in the request body (when present).
A valid signature means the request is legitimate and hasn't been tampered with during transit.
<Note> We recommend that print partners cache Canva's public keys on their system and only call the Get signing keys endpoint to refresh the cache if an unrecognized key is detected.
This reduces the number of network calls, while allowing Canva to rotate the keys when necessary. </Note>
Cancel Order
Cancels items in an order in the print partner's system.
For cancel requests, Canva sends the item_reference_ids to cancel. For cancelling an entire order, Canva sends the item_reference_ids for all items in the order.
The request can be denied if the cancellation is not possible. For example, if production on the order's item has already started.
HTTP method and URL path
POST https://{yourPrintApiUrl}/v1/orders/{orderReferenceId}/cancel
Header parameters
<Prop.List> <Prop name="Content-Type" type="string" required> Indicates the media type of the information sent in the request. This must be set to application/json.
For example: `Content-Type: application/json`
</Prop>
<Prop name="X-Canva-Public-Api-Version" type="string"> The version of the Canva Print API used in the request. If not specified, the latest version is assumed. </Prop>
<Prop name="X-Canva-Signature" type="string" required> The Canva request signature. This is used to verify the request is legitimate and was not tampered with in transit. </Prop> </Prop.List>
Path parameters
<Prop.List> <Prop name="orderReferenceId" type="string" required> Unique, case-sensitive string identifying the order in Canva's system. </Prop> </Prop.List>
Body parameters
<Prop.List> <Prop name="request_type" type="string" required> The type of request being made.
<Prop.Extras>
**Available values:** The only valid value is `cancel_order`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required> A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the orderReferenceId path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="cancel_details" type="CancelDetails" required> Information of the order cancellation.
<PillAccordion title={<>Properties of <strong>cancel_details</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="item_reference_ids" type="string[]" required>
List of item IDs to be canceled in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example request
Cancel item in an order
json
{
"request_type": "cancel_order",
"order_reference_id": "FO123456789",
"cancel_details": {
"item_reference_ids": [
"FI123456789"
]
}
}Success response
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
<Prop.List> <Prop name="order" type="Order" required mode="output"> An order.
<Tabs>
<Tab name="pickup">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `pickup`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="pickup_location_reference" type="string" required mode="output">
The reference ID for the pickup location of an order, as specified by the Canva user placing the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
<Tab name="delivery">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `delivery`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The Items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_address" type="Address" required mode="output">
An address.
<PillAccordion title={<>Properties of <strong>delivery_address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required mode="output">
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required mode="output">
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required mode="output">
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string" mode="output">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string" mode="output">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string" mode="output">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_shipping_tier" type="string" required mode="output">
A Canva defined enum of potential shipping tiers. Each tier describes a different speed and cost of delivery. Partners are expected to interpret this according to contractual agreements.
<Prop.Extras>
**Available values:**
* `economy`: Economy delivery tier.
* `standard`: Standard delivery tier.
* `express`: Express delivery tier.
</Prop.Extras>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="dispatch_location_reference" type="string" required mode="output">
The reference ID for the dispatch location for the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="shipments" type="Shipment[]" mode="output">
A list of shipments for the order.
<PillAccordion title={<>Properties of <strong>shipments</strong></>}>
<Prop.List>
<Prop name="items" type="ShipmentItem[]" required mode="output">
The items included in the shipment.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item that were shipped.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="tracking_number" type="string" mode="output">
The tracking number provided by the carrier.
<Prop.Extras>
**Minimum length:** `1`
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="carrier" type="string" mode="output">
The Canva-supported carrier delivering the shipment.
<Prop.Extras>
**Available values:**
* `allied_express`
* `allwayex`
* `amazon`
* `ams`
* `asendia`
* `aus_post`
* `b2c`
* `blue_dart`
* `bpost`
* `bring_no`
* `canada_post`
* `carriers`
* `chitchats`
* `chronopost`
* `correios`
* `correos`
* `correos_express`
* `couriers_please`
* `deutsche_post`
* `dhl`
* `dpd`
* `dpd_uk`
* `estafeta`
* `evri`
* `fastway`
* `fedex`
* `fleet_optics`
* `gls`
* `hunter_express`
* `ics`
* `icumulus`
* `india_post`
* `japan_post`
* `landmark_global`
* `laposte`
* `loomis_express`
* `lotte`
* `newzealand_couriers`
* `norsk_global`
* `paquetexpress`
* `parcel_force`
* `pitney_bowes`
* `post_nl`
* `post_nord`
* `purolator`
* `qxpress`
* `royal_mail`
* `sagawa`
* `sda`
* `seur`
* `spring_gds`
* `star_track`
* `swiss_post`
* `tnt`
* `toll`
* `uniuni`
* `ups`
* `usps`
* `yamato`
</Prop.Extras>
</Prop>
<Prop name="dispatched_at" type="integer" mode="output">
When the shipment was dispatched, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="dispatch_location_reference" type="string" mode="output">
The location ID of where the shipment was dispatched.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example responses
Cancel delivery order
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "canceled",
"sku_reference": "IN00030",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726449800
}
}Partially cancel order: delivery order, multiple items (invitation and canvas) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "canceled",
"sku_reference": "IN00030",
"quantity": 50
},
{
"item_reference_id": "FI987654321",
"status": "received",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf",
"created_at": 1726448251,
"updated_at": 1726449000
}
}Error responses
400 Bad Request. For example, an invalid payload format.
401 Unauthorized. For example, an invalid signature.
403 Forbidden. For example, an idempotent order issue, or the order doesn't exist.
405 Not Allowed. For example, the request isn't allowed because of the order state, or it isn't supported or implemented.
Create Order
Creates an order on the print partner's system. This operation lets Canva request a partner to commence production on an order.
As part of the request, Canva sends an orderReferenceId and a list of items to print.
Requests to this endpoint should be idempotent. If a provided orderReferenceId already exists in the partner system, and:
- The item
item_reference_ids match and are not canceled: A success response should be returned. - The item
item_reference_ids match but items requested in the request are canceled: An error response should be returned. - The item
item_reference_ids don't match: An error response should be returned.
HTTP method and URL path
POST https://{yourPrintApiUrl}/v1/orders
Header parameters
<Prop.List> <Prop name="Content-Type" type="string" required> Indicates the media type of the information sent in the request. This must be set to application/json.
For example: `Content-Type: application/json`
</Prop>
<Prop name="X-Canva-Public-Api-Version" type="string"> The version of the Canva Print API used in the request. If not specified, the latest version is assumed. </Prop>
<Prop name="X-Canva-Signature" type="string" required> The Canva request signature. This is used to verify the request is legitimate and was not tampered with in transit. </Prop> </Prop.List>
Body parameters
<Prop.List> <Prop name="request_type" type="string" required> The type of request being made.
<Prop.Extras>
**Available values:** The only valid value is `create_order`.
</Prop.Extras>
</Prop>
<Prop name="order" type="CreateOrder" required> Describes an order to create.
<Tabs>
<Tab name="pickup">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required>
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `pickup`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required>
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="CreateItem[]" required>
Items to create.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required>
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required>
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="artworks" type="Artwork[]" required>
The artworks of the item.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>artworks</strong></>}>
<Prop.List>
<Prop name="url" type="string" required>
A temporary URL for the partner to download a production-quality print file for an item.
</Prop>
<Prop name="print_area" type="string" required>
Where on a product an artwork file is expected to appear.
* `cover`
* `front`
* `back`
* `sheets`
* `none`
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="orientation" type="string" required>
The physical orientation of the file.
<Prop.Extras>
**Maximum length:** `255`
**Available values:**
* `portrait`
* `landscape`
* `square`
</Prop.Extras>
</Prop>
<Prop name="pages" type="integer">
The number of the pages in the file. Only provided for PDF.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="quantity" type="integer" required>
The number of copies of an item to produce.
</Prop>
<Prop name="attributes" type="object" required>
A key-value pair of attributes describing an item. These pairs complement the SKU by enumerating the unique attributes it describes. If used by the print partner, the expected values must be confirmed with Canva.
<PillAccordion title={<>Properties of <strong>attributes</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of strings" required>
A key-value pair of attributes describing an item. These pairs complement the SKU by enumerating the unique attributes it describes. If used by the print partner, the expected values must be confirmed with Canva.
```json
{
"paperFinish": "matte",
"paperType": "premium",
"productSize": "portrait"
}
```
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="add_on_sku_reference" type="string">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="mockup_url" type="string">
A temporary URL for the partner to download a mockup file displaying artwork imposed on a product for an item. This is included for certain products, generally apparel. This is controlled by Canva's internal product definition and not an API configuration.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required>
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required>
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required>
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required>
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="preferred_production_location_reference" type="string" required>
The reference ID for the preferred production location for the order. Partners can override this if the selected location is unsuitable, but partners must notify Canva through a production update if this occurs.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="pickup_location_reference" type="string" required>
The reference ID for the pickup location of an order, as specified by the Canva user placing the order. Partners can't override this selection.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="order_invoice_url" type="string">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
<Tab name="delivery">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required>
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `delivery`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required>
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="CreateItem[]" required>
Items to create.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required>
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required>
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="artworks" type="Artwork[]" required>
The artworks of the item.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>artworks</strong></>}>
<Prop.List>
<Prop name="url" type="string" required>
A temporary URL for the partner to download a production-quality print file for an item.
</Prop>
<Prop name="print_area" type="string" required>
Where on a product an artwork file is expected to appear.
* `cover`
* `front`
* `back`
* `sheets`
* `none`
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="orientation" type="string" required>
The physical orientation of the file.
<Prop.Extras>
**Maximum length:** `255`
**Available values:**
* `portrait`
* `landscape`
* `square`
</Prop.Extras>
</Prop>
<Prop name="pages" type="integer">
The number of the pages in the file. Only provided for PDF.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="quantity" type="integer" required>
The number of copies of an item to produce.
</Prop>
<Prop name="attributes" type="object" required>
A key-value pair of attributes describing an item. These pairs complement the SKU by enumerating the unique attributes it describes. If used by the print partner, the expected values must be confirmed with Canva.
<PillAccordion title={<>Properties of <strong>attributes</strong></>}>
<Prop.List>
<Prop name="<KEY>" type="object of strings" required>
A key-value pair of attributes describing an item. These pairs complement the SKU by enumerating the unique attributes it describes. If used by the print partner, the expected values must be confirmed with Canva.
```json
{
"paperFinish": "matte",
"paperType": "premium",
"productSize": "portrait"
}
```
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="add_on_sku_reference" type="string">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="mockup_url" type="string">
A temporary URL for the partner to download a mockup file displaying artwork imposed on a product for an item. This is included for certain products, generally apparel. This is controlled by Canva's internal product definition and not an API configuration.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required>
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required>
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required>
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required>
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_address" type="Address" required>
An address.
<PillAccordion title={<>Properties of <strong>delivery_address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required>
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required>
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required>
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_shipping_tier" type="string" required>
A Canva defined enum of potential shipping tiers. Each tier describes a different speed and cost of delivery. Partners are expected to interpret this according to contractual agreements.
<Prop.Extras>
**Available values:**
* `economy`: Economy delivery tier.
* `standard`: Standard delivery tier.
* `express`: Express delivery tier.
</Prop.Extras>
</Prop>
<Prop name="preferred_production_location_reference" type="string" required>
The reference ID for the preferred production location for the order. Partners can override this if the selected location is unsuitable, but partners must notify Canva through a production update if this occurs.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="preferred_dispatch_location_reference" type="string" required>
The reference ID for the preferred dispatch location for an order, as determined by Canva's internal routing. Partners can override this if the selected location is unsuitable, but partners must notify Canva through a production update if this occurs. Generally, this is the same as the preferred production location, but they are separated for future flexibility.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="order_invoice_url" type="string">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example requests
Create order: delivery, single item (invitation)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create order: delivery, single item (T-shirt)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "TSHIRT_DELUXE_WHITE_MENS_M",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/front.png",
"print_area": "front",
"orientation": "portrait"
},
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/back.png",
"print_area": "back",
"orientation": "portrait"
}
],
"mockup_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/mockup.png",
"quantity": 1,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create order: delivery, single item (photobook)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "PHBOOK_11X8.5IN_HARD-COVER_SOFT-TOUCH",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/cover.pdf",
"print_area": "cover",
"orientation": "portrait",
"pages": 1
},
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 20
}
],
"quantity": 1,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create order: delivery, single item (canvas)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "CANVAS_PREMIUM_11X14IN_WOODGRAIN-FRAME",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/sheets.jpg",
"print_area": "sheets",
"orientation": "portrait"
}
],
"quantity": 1,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create order: delivery, single item (invitations) with add ons (envelopes)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create Order: delivery, multiple items (canvas and invitations)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "CANVAS_PREMIUM_11X14IN_WOODGRAIN-FRAME",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/sheets.jpg",
"print_area": "sheets",
"orientation": "portrait"
}
],
"quantity": 1,
"attributes": {}
},
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create Order: delivery, multiple items (canvas and invitations) with add ons (envelopes)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "CANVAS_PREMIUM_11X14IN_WOODGRAIN-FRAME",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/sheets.jpg",
"print_area": "sheets",
"orientation": "portrait"
}
],
"quantity": 1,
"attributes": {}
},
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"preferred_production_location_reference": "partnerLocation1234",
"preferred_dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf"
}
}Create order: pickup, single item (invitations)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"preferred_production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice"
}
}Create order: pickup, single item (invitations) with add ons (envelopes)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"preferred_production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice"
}
}Create order: pickup, multiple items (invitations and canvas)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
},
{
"item_reference_id": "FI123456789",
"sku_reference": "CANVAS_PREMIUM_11X14IN_WOODGRAIN-FRAME",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/artwork/sheets.jpg",
"print_area": "sheets",
"orientation": "portrait"
}
],
"quantity": 1,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"preferred_production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice"
}
}Create order: pickup, multiple items (invitations) with add ons (envelopes)
json
{
"request_type": "create_order",
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"items": [
{
"item_reference_id": "FI123456789",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
},
{
"item_reference_id": "FI987654321",
"sku_reference": "IN00030",
"artworks": [
{
"url": "https://s3-external-1.amazonaws.com/bucket/FI987654321/sheets.pdf",
"print_area": "sheets",
"orientation": "portrait",
"pages": 2
}
],
"quantity": 50,
"attributes": {}
}
],
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"preferred_production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice"
}
}Success response
If successful, the endpoint returns a 201 response with a JSON body with the following parameters:
<Prop.List> <Prop name="order" type="Order" required mode="output"> An order.
<Tabs>
<Tab name="pickup">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `pickup`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="pickup_location_reference" type="string" required mode="output">
The reference ID for the pickup location of an order, as specified by the Canva user placing the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
<Tab name="delivery">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `delivery`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The Items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_address" type="Address" required mode="output">
An address.
<PillAccordion title={<>Properties of <strong>delivery_address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required mode="output">
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required mode="output">
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required mode="output">
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string" mode="output">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string" mode="output">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string" mode="output">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_shipping_tier" type="string" required mode="output">
A Canva defined enum of potential shipping tiers. Each tier describes a different speed and cost of delivery. Partners are expected to interpret this according to contractual agreements.
<Prop.Extras>
**Available values:**
* `economy`: Economy delivery tier.
* `standard`: Standard delivery tier.
* `express`: Express delivery tier.
</Prop.Extras>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="dispatch_location_reference" type="string" required mode="output">
The reference ID for the dispatch location for the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="shipments" type="Shipment[]" mode="output">
A list of shipments for the order.
<PillAccordion title={<>Properties of <strong>shipments</strong></>}>
<Prop.List>
<Prop name="items" type="ShipmentItem[]" required mode="output">
The items included in the shipment.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item that were shipped.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="tracking_number" type="string" mode="output">
The tracking number provided by the carrier.
<Prop.Extras>
**Minimum length:** `1`
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="carrier" type="string" mode="output">
The Canva-supported carrier delivering the shipment.
<Prop.Extras>
**Available values:**
* `allied_express`
* `allwayex`
* `amazon`
* `ams`
* `asendia`
* `aus_post`
* `b2c`
* `blue_dart`
* `bpost`
* `bring_no`
* `canada_post`
* `carriers`
* `chitchats`
* `chronopost`
* `correios`
* `correos`
* `correos_express`
* `couriers_please`
* `deutsche_post`
* `dhl`
* `dpd`
* `dpd_uk`
* `estafeta`
* `evri`
* `fastway`
* `fedex`
* `fleet_optics`
* `gls`
* `hunter_express`
* `ics`
* `icumulus`
* `india_post`
* `japan_post`
* `landmark_global`
* `laposte`
* `loomis_express`
* `lotte`
* `newzealand_couriers`
* `norsk_global`
* `paquetexpress`
* `parcel_force`
* `pitney_bowes`
* `post_nl`
* `post_nord`
* `purolator`
* `qxpress`
* `royal_mail`
* `sagawa`
* `sda`
* `seur`
* `spring_gds`
* `star_track`
* `swiss_post`
* `tnt`
* `toll`
* `uniuni`
* `ups`
* `usps`
* `yamato`
</Prop.Extras>
</Prop>
<Prop name="dispatched_at" type="integer" mode="output">
When the shipment was dispatched, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="dispatch_location_reference" type="string" mode="output">
The location ID of where the shipment was dispatched.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example responses
Delivery order, single item (invitation)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Delivery order, single item (invitation) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Delivery order, multiple items (invitation and canvas) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
},
{
"item_reference_id": "FI987654321",
"status": "received",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Pickup order, single item (invitation)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"quantity": 50
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Pickup order, single item (invitation) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Pickup order, multiple items (invitation and canvas) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
},
{
"item_reference_id": "FI987654321",
"status": "received",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Error responses
400 Bad Request. For example, an invalid payload format.
401 Unauthorized. For example, an invalid signature.
Find Locations
Gets up-to-date information on the print partner's locations that support in-store pickup.
Canva is interested in:
- The address of each pickup location.
- Production and transfer locations that supply to each pickup location.
- The opening hours of each pickup location.
HTTP method and URL path
GET https://{yourPrintApiUrl}/locations
Header parameters
<Prop.List> <Prop name="X-Canva-Public-Api-Version" type="string"> The version of the Canva Print API used in the request. If not specified, the latest version is assumed. </Prop>
<Prop name="X-Canva-Signature" type="string" required> The Canva request signature. This is used to verify the request is legitimate and was not tampered with in transit. </Prop> </Prop.List>
Query parameters
<Prop.List> <Prop name="country" type="string"> The ISO 3166-1 alpha-2 country code to filter the returned partner locations. </Prop>
<Prop name="continuation" type="string"> If the success response contains a continuation token, the list contains more items you can list. You can use this token as a query parameter and retrieve more items from the list.
To retrieve all items, you might need to make multiple requests.
</Prop>
<Prop name="limit" type="integer" required> The limit for the number of results to return. If the available items are more than the limit, then the response will include a continuation token. </Prop> </Prop.List>
Success response
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
<Prop.List> <Prop name="locations" type="PickupLocation[]" required mode="output"> List of pickup locations currently available for the partner.
<PillAccordion title={<>Properties of <strong>locations</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="id" type="string" required mode="output">
The internal reference of the location on the partners system.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="display_name" type="string" required mode="output">
The display name of the location. This is what Canva customers can expect the location to be called.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The contact phone number of the location.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="timezone" type="string" required mode="output">
The timezone of the location in tz format.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="address" type="Address" required mode="output">
An address.
<PillAccordion title={<>Properties of <strong>address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required mode="output">
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required mode="output">
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required mode="output">
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string" mode="output">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string" mode="output">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string" mode="output">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="geolocation" type="Geolocation" required mode="output">
Longitude and latitude of a location.
<PillAccordion title={<>Properties of <strong>geolocation</strong></>}>
<Prop.List>
<Prop name="latitude" type="number" required mode="output">
The latitude of the geolocation.
<Prop.Extras>
**Minimum:** `-90`
**Maximum:** `90`
</Prop.Extras>
</Prop>
<Prop name="longitude" type="number" required mode="output">
The longitude of the geolocation.
<Prop.Extras>
**Minimum:** `-180`
**Maximum:** `180`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="pickup_hours" type="PickupHours" required mode="output">
Pickup hours for a pickup location. If hours do not exist for a day, the store is considered closed.
<PillAccordion title={<>Properties of <strong>pickup_hours</strong></>}>
<Prop.List>
<Prop name="monday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>monday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="tuesday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>tuesday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="wednesday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>wednesday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="thursday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>thursday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="friday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>friday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="saturday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>saturday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="sunday_hours" type="Hours" mode="output">
Details on the opening and closing time for a pickup location.
The open time must be before close time. Hours must be open for at least a minute.
<PillAccordion title={<>Properties of <strong>sunday_hours</strong></>}>
<Prop.List>
<Prop name="open_time_hour" type="integer" required mode="output">
The hour part of the time the store opens in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="open_time_minute" type="integer" required mode="output">
The minute part of the time the store opens.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
<Prop name="close_time_hour" type="integer" required mode="output">
The hour part of the time the store closes in 24-hour format.
<Prop.Extras>
**Maximum:** `23`
</Prop.Extras>
</Prop>
<Prop name="close_time_minute" type="integer" required mode="output">
The minute part of the time the store closes.
<Prop.Extras>
**Maximum:** `59`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="receiving_from_locations" type="string[]" mode="output">
A list of locations that are allowed to produce or transfer items to this pickup location.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="continuation" type="string" mode="output"> A continuation token. If the success response contains a continuation token, the list contains more items you can list. You can use this token as a query parameter and retrieve more items from the list. This value should be NULL if no more results are available.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop> </Prop.List>
Example response
json
{
"locations": [
{
"id": "partnerLocation1234",
"display_name": "Partner Fake Location",
"phone": "(555) 555-1234",
"timezone": "Australia/Melbourne",
"address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"geolocation": {
"latitude": -33.8853,
"longitude": 151.2088
},
"receiving_from_locations": [
"partnerLocation1234_production",
"partnerLocation1234_transfer"
],
"pickup_hours": {
"monday_hours": {
"open_time_hour": 10,
"open_time_minute": 0,
"close_time_hour": 17,
"close_time_minute": 30
},
"tuesday_hours": {
"open_time_hour": 10,
"open_time_minute": 0,
"close_time_hour": 17,
"close_time_minute": 30
},
"wednesday_hours": {
"open_time_hour": 10,
"open_time_minute": 0,
"close_time_hour": 17,
"close_time_minute": 30
},
"thursday_hours": {
"open_time_hour": 10,
"open_time_minute": 0,
"close_time_hour": 17,
"close_time_minute": 30
},
"friday_hours": {
"open_time_hour": 10,
"open_time_minute": 0,
"close_time_hour": 17,
"close_time_minute": 30
},
"saturday_hours": {
"open_time_hour": 9,
"open_time_minute": 0,
"close_time_hour": 17,
"close_time_minute": 30
},
"sunday_hours": {
"open_time_hour": 9,
"open_time_minute": 0,
"close_time_hour": 12,
"close_time_minute": 0
}
}
}
],
"continuation": "edf3"
}Error responses
400 Bad Request. For example, an invalid payload format.
401 Unauthorized. For example, an invalid signature.
Get Order
Gets an order from the print partner's system.
HTTP method and URL path
GET https://{yourPrintApiUrl}/v1/orders/{orderReferenceId}
Header parameters
<Prop.List> <Prop name="X-Canva-Public-Api-Version" type="string"> The version of the Canva Print API used in the request. If not specified, the latest version is assumed. </Prop>
<Prop name="X-Canva-Signature" type="string" required> The Canva request signature. This is used to verify the request is legitimate and was not tampered with in transit. </Prop> </Prop.List>
Path parameters
<Prop.List> <Prop name="orderReferenceId" type="string" required> Unique, case-sensitive string identifying the order in Canva's system. </Prop> </Prop.List>
Success response
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
<Prop.List> <Prop name="order" type="Order" required mode="output"> An order.
<Tabs>
<Tab name="pickup">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `pickup`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="pickup_location_reference" type="string" required mode="output">
The reference ID for the pickup location of an order, as specified by the Canva user placing the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
<Tab name="delivery">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `delivery`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The Items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_address" type="Address" required mode="output">
An address.
<PillAccordion title={<>Properties of <strong>delivery_address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required mode="output">
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required mode="output">
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required mode="output">
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string" mode="output">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string" mode="output">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string" mode="output">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_shipping_tier" type="string" required mode="output">
A Canva defined enum of potential shipping tiers. Each tier describes a different speed and cost of delivery. Partners are expected to interpret this according to contractual agreements.
<Prop.Extras>
**Available values:**
* `economy`: Economy delivery tier.
* `standard`: Standard delivery tier.
* `express`: Express delivery tier.
</Prop.Extras>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="dispatch_location_reference" type="string" required mode="output">
The reference ID for the dispatch location for the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="shipments" type="Shipment[]" mode="output">
A list of shipments for the order.
<PillAccordion title={<>Properties of <strong>shipments</strong></>}>
<Prop.List>
<Prop name="items" type="ShipmentItem[]" required mode="output">
The items included in the shipment.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item that were shipped.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="tracking_number" type="string" mode="output">
The tracking number provided by the carrier.
<Prop.Extras>
**Minimum length:** `1`
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="carrier" type="string" mode="output">
The Canva-supported carrier delivering the shipment.
<Prop.Extras>
**Available values:**
* `allied_express`
* `allwayex`
* `amazon`
* `ams`
* `asendia`
* `aus_post`
* `b2c`
* `blue_dart`
* `bpost`
* `bring_no`
* `canada_post`
* `carriers`
* `chitchats`
* `chronopost`
* `correios`
* `correos`
* `correos_express`
* `couriers_please`
* `deutsche_post`
* `dhl`
* `dpd`
* `dpd_uk`
* `estafeta`
* `evri`
* `fastway`
* `fedex`
* `fleet_optics`
* `gls`
* `hunter_express`
* `ics`
* `icumulus`
* `india_post`
* `japan_post`
* `landmark_global`
* `laposte`
* `loomis_express`
* `lotte`
* `newzealand_couriers`
* `norsk_global`
* `paquetexpress`
* `parcel_force`
* `pitney_bowes`
* `post_nl`
* `post_nord`
* `purolator`
* `qxpress`
* `royal_mail`
* `sagawa`
* `sda`
* `seur`
* `spring_gds`
* `star_track`
* `swiss_post`
* `tnt`
* `toll`
* `uniuni`
* `ups`
* `usps`
* `yamato`
</Prop.Extras>
</Prop>
<Prop name="dispatched_at" type="integer" mode="output">
When the shipment was dispatched, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="dispatch_location_reference" type="string" mode="output">
The location ID of where the shipment was dispatched.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example responses
Delivery order, single item (invitation)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Delivery order, single item (invitation) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Delivery order, single item (invitation) with add ons (envelopes), with shipment
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "shipped",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"shipments": [
{
"tracking_number": "123456789",
"carrier": "fedex",
"items": [
{
"item_reference_id": "FI123456789",
"quantity": 50
}
],
"dispatched_at": 1726448500,
"dispatch_location_reference": "partnerLocation1234"
}
],
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448500
}
}Delivery order, single item (invitation) with add ons (envelopes), with error
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "producing",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50,
"error_details": {
"issue_origin": "user_address",
"description": "Address cannot be found. Please specify a valid delivery address."
}
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448500
}
}Delivery order, multiple items (invitation and canvas) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
},
{
"item_reference_id": "FI987654321",
"status": "received",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Delivery order, multiple items (invitation and canvas) with add ons (envelopes), with shipments
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "shipped",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
},
{
"item_reference_id": "FI987654321",
"status": "shipped",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 1",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"shipments": [
{
"tracking_number": "123456789",
"carrier": "fedex",
"items": [
{
"item_reference_id": "FI123456789",
"quantity": 1000
}
],
"dispatched_at": 1726448500,
"dispatch_location_reference": "partnerLocation1234"
},
{
"tracking_number": "987654321",
"carrier": "fedex",
"items": [
{
"item_reference_id": "FI987654321",
"quantity": 5
}
],
"dispatched_at": 1726448500,
"dispatch_location_reference": "partnerLocation1234"
}
],
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice.pdf",
"created_at": 1726448251,
"updated_at": 1726448500
}
}Pickup order, single item (invitation)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"quantity": 50
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Pickup order, single item (invitation) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Pickup order, single item (invitation), with error
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "producing",
"sku_reference": "IN00030",
"quantity": 50,
"error_details": {
"issue_origin": "order_url",
"description": "Unable to access design url."
}
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448500
}
}Pickup order, multiple items (invitation and canvas) with add ons (envelopes)
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50
},
{
"item_reference_id": "FI987654321",
"status": "received",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448251
}
}Pickup order, multiple item (invitation and canvas) with add ons (envelopes), with error
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "Charles Boyle",
"phone": "(555) 555-1234",
"email": "charlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "producing",
"sku_reference": "IN00030",
"add_on_sku_reference": "EN00006",
"quantity": 50,
"error_details": {
"issue_origin": "order_url",
"description": "Unable to access design url."
}
},
{
"item_reference_id": "FI987654321",
"status": "producing",
"sku_reference": "CANVAS_PREMIUM_16X20_STRETCHED",
"quantity": 5,
"error_details": {
"issue_origin": "order_url",
"description": "Unable to access design url."
}
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726448500
}
}Error responses
400 Bad Request. For example, an invalid payload format.
401 Unauthorized. For example, an invalid signature.
403 Forbidden. For example, an idempotent order issue, or the order doesn't exist.
Update Order
Updates an order in the print partner's system.
- Changes to an order are restricted only to the delivery address and customer details of the order.
- Updates to an order aren't allowed if every item of the order has been canceled.
- The order update request can be denied if the update isn't possible. For example, if the order contains items that have already shipped.
HTTP method and URL path
PATCH https://{yourPrintApiUrl}/v1/orders/{orderReferenceId}
Header parameters
<Prop.List> <Prop name="Content-Type" type="string" required> Indicates the media type of the information sent in the request. This must be set to application/json.
For example: `Content-Type: application/json`
</Prop>
<Prop name="X-Canva-Public-Api-Version" type="string"> The version of the Canva Print API used in the request. If not specified, the latest version is assumed. </Prop>
<Prop name="X-Canva-Signature" type="string" required> The Canva request signature. This is used to verify the request is legitimate and was not tampered with in transit. </Prop> </Prop.List>
Path parameters
<Prop.List> <Prop name="orderReferenceId" type="string" required> Unique, case-sensitive string identifying the order in Canva's system. </Prop> </Prop.List>
Body parameters
<Prop.List> <Prop name="request_type" type="string" required> The type of request being made.
<Prop.Extras>
**Available values:** The only valid value is `update_order`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required> A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the orderReferenceId path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="updates" type="Updates" required> Updates to the order. The request must contain at least one of customer_details or delivery_address.
<PillAccordion title={<>Properties of <strong>updates</strong></>} defaultExpanded={true}>
<Prop.List>
<Prop name="customer_details" type="CustomerDetails">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required>
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required>
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required>
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_address" type="Address">
An address.
<PillAccordion title={<>Properties of <strong>delivery_address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required>
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required>
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required>
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop> </Prop.List>
Example requests
Update customer details and delivery address for a delivery order
json
{
"request_type": "update_order",
"order_reference_id": "FB123456789",
"updates": {
"customer_details": {
"name": "NotCharles Boyle",
"phone": "(555) 555-0000",
"email": "notcharlesboyle@email.com"
},
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 2",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
}
}
}Update customer details for a pickup order
json
{
"request_type": "update_order",
"order_reference_id": "FB123456789",
"updates": {
"customer_details": {
"name": "NotCharles Boyle",
"phone": "(555) 555-0000",
"email": "notcharlesboyle@email.com"
}
}
}Success response
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
<Prop.List> <Prop name="order" type="Order" required mode="output"> An order.
<Tabs>
<Tab name="pickup">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `pickup`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="pickup_location_reference" type="string" required mode="output">
The reference ID for the pickup location of an order, as specified by the Canva user placing the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
<Tab name="delivery">
The type of order.
<Prop.List>
<Prop name="order_type" type="string" required mode="output">
The type of order.
<Prop.Extras>
**Available values:** The only valid value is `delivery`.
</Prop.Extras>
</Prop>
<Prop name="order_reference_id" type="string" required mode="output">
A unique, case-sensitive ID of the order in Canva's system. This must be the same value as the `orderReferenceId` path parameter.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="items" type="Item[]" required mode="output">
The Items in the order.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="status" type="string" required mode="output">
The updated production status of the item.
<Prop.Extras>
**Available values:**
* `received`: The order item was received and is pending further processing.
* `producing`: The order item production has started.
* `produced`: The order item production has completed.
* `packaging`: The order item packaging has started.
* `ready_for_pickup`: The order item was shipped to the receiver.
* `picked_up`: The order item is ready for pickup in store.
* `shipped`: The order item was picked up from the store.
* `canceled`: The order item was canceled.
</Prop.Extras>
</Prop>
<Prop name="sku_reference" type="string" required mode="output">
Partner-facing reference for an item's SKU. Describes a specific variant of a product to be produced.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item to produce.
</Prop>
<Prop name="add_on_sku_reference" type="string" mode="output">
Partner-facing reference for an item add on SKU. Sometimes referred to as a stock item. For example, envelopes with postcards.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="error_details" type="ErrorDetails" mode="output">
The error details of the item. Errors details should be cleared from an item after it has been resolved.
<PillAccordion title={<>Properties of <strong>error_details</strong></>}>
<Prop.List>
<Prop name="issue_origin" type="string" required mode="output">
The origin of the issue.
<Prop.Extras>
**Available values:**
* `production`
* `order_url`
* `user_details`
* `user_address`
* `delivery`
* `unknown`
</Prop.Extras>
</Prop>
<Prop name="description" type="string" required mode="output">
A human readable message that describes the cause of the error.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="customer_details" type="CustomerDetails" required mode="output">
The customer.
<PillAccordion title={<>Properties of <strong>customer_details</strong></>}>
<Prop.List>
<Prop name="name" type="string" required mode="output">
The full name of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="phone" type="string" required mode="output">
The phone number of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="email" type="string" required mode="output">
The email address of the customer.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_address" type="Address" required mode="output">
An address.
<PillAccordion title={<>Properties of <strong>delivery_address</strong></>}>
<Prop.List>
<Prop name="address_line1" type="string" required mode="output">
The address line 1 portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="city" type="string" required mode="output">
The city portion of the address.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="country" type="string" required mode="output">
ISO 3166-1 alpha-2 country code of the address. Includes the exceptionally reserved code IC for the autonomous Spanish region Canary Islands.
<Prop.Extras>
**Maximum length:** `2`
</Prop.Extras>
</Prop>
<Prop name="address_line2" type="string" mode="output">
The address line 2 portion of the address. Can contain additional address information such as unit number or house name.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="subdivision" type="string" mode="output">
ISO 3166-2 subdivision code of the address.
<Prop.Extras>
**Maximum length:** `6`
</Prop.Extras>
</Prop>
<Prop name="postcode" type="string" mode="output">
The postcode/zipcode portion of the address.
<Prop.Extras>
**Maximum length:** `12`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="delivery_shipping_tier" type="string" required mode="output">
A Canva defined enum of potential shipping tiers. Each tier describes a different speed and cost of delivery. Partners are expected to interpret this according to contractual agreements.
<Prop.Extras>
**Available values:**
* `economy`: Economy delivery tier.
* `standard`: Standard delivery tier.
* `express`: Express delivery tier.
</Prop.Extras>
</Prop>
<Prop name="production_location_reference" type="string" required mode="output">
The reference ID for the production location of the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="dispatch_location_reference" type="string" required mode="output">
The reference ID for the dispatch location for the order.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="created_at" type="integer" required mode="output">
When the order was created, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="updated_at" type="integer" required mode="output">
When the order was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="shipments" type="Shipment[]" mode="output">
A list of shipments for the order.
<PillAccordion title={<>Properties of <strong>shipments</strong></>}>
<Prop.List>
<Prop name="items" type="ShipmentItem[]" required mode="output">
The items included in the shipment.
<Prop.Extras>
**Minimum length:** `1`
</Prop.Extras>
<PillAccordion title={<>Properties of <strong>items</strong></>}>
<Prop.List>
<Prop name="item_reference_id" type="string" required mode="output">
A unique, case-sensitive ID for an order item that the partner can use when communicating with Canva.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="quantity" type="integer" required mode="output">
The number of copies of an item that were shipped.
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="tracking_number" type="string" mode="output">
The tracking number provided by the carrier.
<Prop.Extras>
**Minimum length:** `1`
**Maximum length:** `255`
</Prop.Extras>
</Prop>
<Prop name="carrier" type="string" mode="output">
The Canva-supported carrier delivering the shipment.
<Prop.Extras>
**Available values:**
* `allied_express`
* `allwayex`
* `amazon`
* `ams`
* `asendia`
* `aus_post`
* `b2c`
* `blue_dart`
* `bpost`
* `bring_no`
* `canada_post`
* `carriers`
* `chitchats`
* `chronopost`
* `correios`
* `correos`
* `correos_express`
* `couriers_please`
* `deutsche_post`
* `dhl`
* `dpd`
* `dpd_uk`
* `estafeta`
* `evri`
* `fastway`
* `fedex`
* `fleet_optics`
* `gls`
* `hunter_express`
* `ics`
* `icumulus`
* `india_post`
* `japan_post`
* `landmark_global`
* `laposte`
* `loomis_express`
* `lotte`
* `newzealand_couriers`
* `norsk_global`
* `paquetexpress`
* `parcel_force`
* `pitney_bowes`
* `post_nl`
* `post_nord`
* `purolator`
* `qxpress`
* `royal_mail`
* `sagawa`
* `sda`
* `seur`
* `spring_gds`
* `star_track`
* `swiss_post`
* `tnt`
* `toll`
* `uniuni`
* `ups`
* `usps`
* `yamato`
</Prop.Extras>
</Prop>
<Prop name="dispatched_at" type="integer" mode="output">
When the shipment was dispatched, as a Unix timestamp (in seconds since the Unix Epoch).
</Prop>
<Prop name="dispatch_location_reference" type="string" mode="output">
The location ID of where the shipment was dispatched.
<Prop.Extras>
**Maximum length:** `255`
</Prop.Extras>
</Prop>
</Prop.List>
</PillAccordion>
</Prop>
<Prop name="order_invoice_url" type="string" mode="output">
A temporary URL for the print partner to download an order invoice. This can be a taxation requirement for some countries. This is only included for certain partners, and can be configured in the API settings.
</Prop>
</Prop.List>
</Tab>
</Tabs>
</Prop> </Prop.List>
Example responses
Update customer details and delivery address for a delivery order
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "delivery",
"customer_details": {
"name": "NotCharles Boyle",
"phone": "(555) 555-0000",
"email": "notcharlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"quantity": 50
}
],
"delivery_address": {
"address_line1": "374 Johnson Ave, Brooklyn",
"address_line2": "Unit 2",
"city": "New York",
"subdivision": "US-NY",
"postcode": "11206",
"country": "US"
},
"delivery_shipping_tier": "economy",
"production_location_reference": "partnerLocation1234",
"dispatch_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726449800
}
}Update customer details for a pickup order
json
{
"order": {
"order_reference_id": "FB123456789",
"order_type": "pickup",
"customer_details": {
"name": "NotCharles Boyle",
"phone": "(555) 555-0000",
"email": "notcharlesboyle@email.com"
},
"items": [
{
"item_reference_id": "FI123456789",
"status": "received",
"sku_reference": "IN00030",
"quantity": 50
}
],
"production_location_reference": "partnerLocation1234",
"pickup_location_reference": "partnerLocation1234",
"order_invoice_url": "https://s3-external-1.amazonaws.com/bucket/FI123456789/invoice",
"created_at": 1726448251,
"updated_at": 1726449800
}
}