Prodigi Print API

https://www.prodigi.com/print-api/docs/
Admin
Prodigi Print API is a RESTful API platform that enables developers to integrate print and...
Tokens:33,500
Snippets:149
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Order response example

Source: https://www.prodigi.com/print-api/docs/reference

This is an example of the response structure when retrieving a list of orders. It includes order details, pagination information, and a trace parent for correlation.

```json
{
    "outcome": "Ok",
    "orders": [
        {
            "id": "ord_840797",
            // rest of the order
        },
        {
            "id": "ord_839555",
            // rest of the order
        },
        {
            "id": "ord_838659",
            // rest of the order
        },
        {
            "id": "ord_838055",
            // rest of the order
        }
    ],
    "hasMore": true,
    "nextUrl": "https://api.sandbox.prodigi.com/v4.0/Orders?Skip=10",
    "traceParent": "00-cb879e84d8c70a45b5742d34be5f3a6d-4535bc8797a33c49-00"
}
```

--------------------------------

### Authentication Example

Source: https://www.prodigi.com/print-api/docs/reference

Demonstrates how to authenticate API requests using the X-API-Key header.

```APIDOC
## Authentication

Each request to our API requires the use of an authentication header: `X-API-Key`.
You can obtain an API key by signing up for a free Prodigi account.

### Request Example

```curl
https://api.prodigi.com/v4.0/Orders \
  -X GET \
  -H "X-API-Key: your-api-key"
```
```

--------------------------------

### Order actions response example

Source: https://www.prodigi.com/print-api/docs/reference

This is an example response when querying available actions for an order. It indicates whether actions like 'cancel', 'changeRecipientDetails', 'changeShippingMethod', and 'changeMetaData' are available.

```json
{
    "outcome": "Ok",
    "cancel": {
        "isAvailable": "Yes"
    },
    "changeRecipientDetails": {
        "isAvailable": "Yes"
    },
    "changeShippingMethod": {
        "isAvailable": "Yes"
    },
    "changeMetaData": {
        "isAvailable": "Yes"
    },
    "traceParent": "00-e5bcd15ebc235043bf43b6fb209de64e-72320d4625a34a40-00"
}
```

--------------------------------

### Quote Response Example

Source: https://www.prodigi.com/print-api/docs/reference

This is an example of a successful response from the /quotes endpoint. It includes cost summaries, shipment details, and itemized information for the requested quote.

```json
{
    "outcome": "Created",
    "quotes": [
        {
            "shipmentMethod": "Budget",
            "costSummary": {
                "items": {
                    "amount": "79.35",
                    "currency": "GBP"
                },
                "shipping": {
                    "amount": "19.46",
                    "currency": "GBP"
                }
            },
            "shipments": [
                {
                    "carrier": {
                        "name": "Mixed",
                        "service": "Mixed"
                    },
                    "fulfillmentLocation": {
                        "countryCode": "US",
                        "labCode": "us11"
                    },
                    "cost": {
                        "amount": "17.96",
                        "currency": "GBP"
                    },
                    "items": [
                        "qit_f1c1f62b8fd0486da831c9438e89bc25"
                    ]
                },
                {
                    "carrier": {
                        "name": "royalmail",
                        "service": "Standard"
                    },
                    "fulfillmentLocation": {
                        "countryCode": "GB",
                        "labCode": "uk6"
                    },
                    "cost": {
                        "amount": "1.50",
                        "currency": "GBP"
                    },
                    "items": [
                        "qit_a904222e1c964440870f3400bd2d5973"
                    ]
                }
            ],
            "items": [
                {
                    "id": "qit_f1c1f62b8fd0486da831c9438e89bc25",
                    "sku": "GLOBAL-CAN-10X10",
                    "copies": 5,
                    "unitCost": {
                        "amount": "14.37",
                        "currency": "GBP"
                    },
                    "attributes": {
                        "wrap": "ImageWrap"
                    },
                    "assets": [
                        {
                            "printArea": "default"
                        }
                    ]
                },
                {
                    "id": "qit_a904222e1c964440870f3400bd2d5973",
                    "sku": "GLOBAL-TECH-IP11P-FC-CP",
                    "copies": 1,
                    "unitCost": {
                        "amount": "7.50",
                        "currency": "GBP"
                    },
                    "attributes": {},
                    "assets": [
                        {
                            "printArea": "default"
                        }
                    ]
                }
            ]
        }
    ]
}

```

--------------------------------

### Get Product Details

Source: https://www.prodigi.com/print-api/docs/reference

This endpoint returns the Product Details for the requested SKU.

```APIDOC
## Get Product Details

### Description
Retrieves the details for a specific product using its SKU.

### Method
GET

### Endpoint
/v4.0/products/{sku}

### Parameters
#### Path Parameters
- **sku** (string) - Required - The Stock Keeping Unit (SKU) of the product to retrieve.

### Request Example
```bash
curl "https://api.sandbox.prodigi.com/v4.0/products/GLOBAL-CAN-10x10" \
  -X GET \
  -H "X-API-Key: your-api-key"
```

### Response
#### Success Response (200)
- **outcome** (string) - Indicates the result of the operation ('Ok' on success).
- **product** (object) - Contains the product details.
  - **sku** (string) - The product's SKU.
  - **description** (string) - A description of the product.
  - **productDimensions** (object) - Dimensions of the product.
    - **width** (number) - The width of the product.
    - **height** (number) - The height of the product.
    - **units** (string) - The unit of measurement for the dimensions (e.g., 'in').
  - **attributes** (object) - Various attributes of the product.
    - **wrap** (array) - Available wrap options for the product.
  - **printAreas** (object) - Information about the print areas.
    - **default** (object) - Details for the default print area.
      - **required** (boolean) - Whether the default print area is required.
  - **variants** (array) - An array of product variants.
    - **attributes** (object) - Attributes specific to the variant.
      - **wrap** (string) - The wrap type for this variant.
    - **shipsTo** (array) - List of country codes the variant ships to.
    - **printAreaSizes** (object) - Resolution details for the print area of this variant.
      - **default** (object) - Default print area size details.
        - **horizontalResolution** (integer) - The horizontal resolution.
        - **verticalResolution** (integer) - The vertical resolution.

#### Response Example
```json
{
    "outcome": "Ok",
    "product": {
        "sku": "GLOBAL-CAN-10X10",
        "description": "Standard canvas on quality stretcher bar, 25x25cm",
        "productDimensions": {
            "width": 10.0000,
            "height": 10.0000,
            "units": "in"
        },
        "attributes": {
            "wrap": [
                "Black",
                "ImageWrap",
                "MirrorWrap",
                "White"
            ]
        },
        "printAreas": {
            "default": {
                "required": true
            }
        },
        "variants": [
            {
                "attributes": {
                    "wrap": "Black"
                },
                "shipsTo": [
                    "IM",
                    "LU",
                    "ID",
                    "CI",
                    "GR",
                    "FK",
                    "AL",
                    "LA",
                    "KY"
                ],
                "printAreaSizes": {
                    "default": {
                        "horizontalResolution": 1522,
                        "verticalResolution": 1522
                    }
                }
            },
            {
                "attributes": {
                    "wrap": "ImageWrap"
                },
                "shipsTo": [
                    "IM",
                    "LU",
                    "ID",
                    "CI",
                    "GR",
                    "FK",
                    "AL",
                    "LA",
                    "KY"
                ],
                "printAreaSizes": {
                    "default": {
                        "horizontalResolution": 2137,
                        "verticalResolution": 2137
                    }
                }
            },
            {
                "attributes": {
                    "wrap": "MirrorWrap"
                },
                "shipsTo": [
                    "IM",
                    "LU",
                    "ID",
                    "CI",
                    "GR",
                    "FK",
                    "AL",
                    "LA",
                    "KY"
                ],
                "printAreaSizes": {
                    "default": {
                        "horizontalResolution": 1522,
                        "verticalResolution": 1522
                    }
                }
            },
            {
                "attributes": {
                    "wrap": "White"
                },
                "shipsTo": [
                    "IM",
                    "LU",
                    "ID",
                    "CI",
                    "GR",
                    "FK",
                    "AL",
                    "LA",
                    "KY"
                ],
                "printAreaSizes": {
                    "default": {
                        "horizontalResolution": 1522,
                        "verticalResolution": 1522
                    }
                }
            }
        ]
    }
}
```
```

--------------------------------

### Get Product Details

Source: https://www.prodigi.com/print-api/docs/reference

Retrieve product details for a given SKU. Ensure you replace 'your-api-key' with your actual API key.

```curl
curl "https://api.sandbox.prodigi.com/v4.0/products/GLOBAL-CAN-10x10" \
  -X GET \
  -H "X-API-Key: your-api-key"
```

--------------------------------

### Create Order Response

Source: https://www.prodigi.com/print-api/docs/reference

This is an example of a successful response when creating an order. It includes the order ID, status, and details of the created order.

```json
{
    "outcome": "Created",
    "order": {
        "id": "ord_840797",
        "created": "2021-03-11T14:40:05.12Z",
        "lastUpdated": "2021-03-11T14:40:05.2018442Z",
        "callbackUrl": null,
        "merchantReference": "MyMerchantReference1",
        "shippingMethod": "Overnight",
        "idempotencyKey": null,
        "status": {
            "stage": "InProgress",
            "issues": [],
            "details": {
                "downloadAssets": "NotStarted",
                "printReadyAssetsPrepared": "NotStarted",
                "allocateProductionLocation": "NotStarted",
                "inProduction": "NotStarted",
                "shipping": "NotStarted"
            }
        },
        "charges": [],
        "shipments": [],
        "recipient": {
            "name": "Mr Test",
            "email": null,
            "phoneNumber": null,
            "address": {
                "line1": "14 test place",
                "line2": "test",
                "postalOrZipCode": "12345",
                "countryCode": "US",
                "townOrCity": "somewhere",
                "stateOrCounty": null
            }
        },
        "branding": {
            "postcard": { "url" : "https://sample/postcard.jpg"},
            "flyer": { "url" : "https://sample/flyer.pdf"},
            "packing_slip_bw": { "url" : "https://sample/delivery_note_bw.jpg"},
            "packing_slip_color" : { "url" : "https://sample/delivery_note_color.jpg"},
            "sticker_exterior_round" : { "url" : "https://sample/sticker_round.jpg"},
            "sticker_exterior_rectangle"  :{ "url" : "https://sample/sticker_rect.jpg"},
            "sticker_interior_round" : { "url" : "https://sample/sticker_round.jpg"},
            "sticker_interior_rectangle": { "url" : "https://sample/sticker_rect.jpg"}
        },
        "items": [
            {
                "id": "ori_926887",
                "status": "NotYetDownloaded",
                "merchantReference": "item #1",
                "sku": "GLOBAL-CFPM-16X20",
                "copies": 1,
                "sizing": "fillPrintArea",
                "attributes": {
                    "color": "black"
                },
                "assets": [
                    {
                        "id": "ast_114059",
                        "printArea": "default",
                        "md5Hash": "daa1c811c6038e718a23f0d816914b7b",
                        "url": "https://pwintyimages.blob.core.windows.net/samples/stars/test-sample-grey.png",
                        "status": "InProgress"
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### Sample Callback Payload

Source: https://www.prodigi.com/print-api/docs/reference

This is an example of a callback payload received from the Prodigi API when an order's stage changes. It adheres to the CloudEvents specification.

```json
{
    "specversion": "1.0",
    "type": "com.prodigi.order.status.stage.changed#InProgress",
    "source": "http://api.prodigi.com/v4.0/Orders/",
    "id": "evt_305174",
    "time": "2020-08-14T11:51:01.55Z",
    "datacontenttype": "application/json",
    "data": {
      "order": {
        "id": "ord_1469466",
        "created": "2020-08-14T11:50:54.557Z",
        "status": {
          "stage": "InProgress",
          "issues": [],
          "details": {
            "downloadAssets": "InProgress",
            "printReadyAssetsPrepared": "NotStarted",
            "allocateProductionLocation": "NotStarted",
            "inProduction": "NotStarted",
            "shipping": "NotStarted"
          }
        },
        "charges": [],
        "shipments": [],
        "merchantReference": "1",
        "shippingMethod": "Budget",
        "recipient": {
          "name": "Pwinty Test Order",
          "address": {
            "line1": "123 Test Street",
            "line2": "TESTERTON",
            "postalOrZipCode": "TE5 7IN",
            "countryCode": "US",
            "townOrCity": "TEST CITY",
            "stateOrCounty": "TESTSHIRE"
          },
          "email": "mike.hole@prodigi.com",
          "mobilePhoneNumber": "07987654321"
        },
        "items": [
          {
            "id": "ori_1430070",
            "status": "NotYetDownloaded",
            "sku": "GLOBAL-PHO-12X16-PRO-LUS-UK1",
            "copies": 1,
            "sizing": "fillPrintArea",
            "attributes": {},
            "assets": [
              {
                "id": "ast_116447",
                "status": "InProgress",
                "printArea": "default",
                "url": "https://pwintytest.blob.core.windows.net/sample-media/mike/TestCard.png"
              }
            ],
            "recipientCost": {
              "amount": "543.21",
              "currency": "USD"
            }
          }
        ],
        "packingSlip": {
          "url": "https://pwintytest.blob.core.windows.net/sample-media/mike/PackingSlip.png",
          "status": "NotYetDownloaded"
        }
      }
    },
    "subject": "ord_1469466"
  }
```

--------------------------------

### Order Status Object Example

Source: https://www.prodigi.com/print-api/docs/reference

This JSON object represents the status of an order, including its current stage, details of production steps, and any issues encountered.

```json
{
    "stage":"InProgress",
    "details" : {
        "downloadAssets":"InProgress",
        "printReadyAssetsPrepared":"NotStarted",
        "allocateProductionLocation ": "NotStarted",
        "inProduction":"NotStarted",
        "shipping":"NotStarted"
    },
    "issues":[
        {
            "objectId": "ori_12345",
            "errorCode" : "items.assets.NotDownloaded",
            "description" : "Warning: Download attempt 1 of 10 failed for 'default' asset on item 'ori_12345' at location 'http://source.url' "
        },
        {
            "objectId": "ord_829398",
            "errorCode": "RequiresPaymentAuthorisation",
            "description": "Payment authorisation required for 'ord_829398' (195.02USD) please use the following URL to make payment: https://beta-dashboard.pwinty.com/payment/97323",
            "authorisationDetails": {
                "authorisationUrl": "https://beta-dashboard.pwinty.com/payment/97323",
                "paymentDetails": {
                    "amount": "195.02",
                    "currency": "USD"
                }
            }
        }
    ]
}
```

--------------------------------

### Order Creation Response Example

Source: https://www.prodigi.com/print-api/docs/reference

This JSON object represents a successful order creation response. It includes details about the created order, such as its ID, status, recipient information, and items. Note the 'traceParent' for request tracing.

```json
{
    "outcome": "Ok",
    "order": {
        "id": "ord_840797",
        "created": "2021-03-11T14:40:05.12Z",
        "lastUpdated": "2021-03-11T14:40:05.203Z",
        "callbackUrl": null,
        "merchantReference": "MyMerchantReference1",
        "shippingMethod": "Overnight",
        "idempotencyKey": null,
        "status": {
            "stage": "InProgress",
            "issues": [],
            "details": {
                "downloadAssets": "NotStarted",
                "printReadyAssetsPrepared": "NotStarted",
                "allocateProductionLocation": "NotStarted",
                "inProduction": "NotStarted",
                "shipping": "NotStarted"
            }
        },
        "charges": [],
        "shipments": [],
        "recipient": {
            "name": "Mr Test",
            "email": null,
            "phoneNumber": null,
            "address": {
                "line1": "14 test place",
                "line2": "test",
                "postalOrZipCode": "12345",
                "countryCode": "US",
                "townOrCity": "somewhere",
                "stateOrCounty": null
            }
        },
        "items": [
            {
                "id": "ori_926887",
                "status": "NotYetDownloaded",
                "merchantReference": "item #1",
                "sku": "GLOBAL-CFPM-16X20",
                "copies": 1,
                "sizing": "fillPrintArea",
                "attributes": {
                    "color": "black"
                },
                "assets": [
                    {
                        "id": "ast_114059",
                        "printArea": "default",
                        "md5Hash": "daa1c811c6038e718a23f0d816914b7b",
                        "url": "https://pwintyimages.blob.core.windows.net/samples/stars/test-sample-grey.png",
                        "pageCount": 50,
                        "status": "InProgress"
                    }
                ],
                "recipientCost": {
                    "amount": "10.74",
                    "currency": "GBP"
                }
            }
        ],
        "packingSlip": null,
        "metadata": {
            "mycustomkey": "some-guid",
            "someCustomerPreference": {
                "preference1": "something",
                "preference2": "red"
            },
            "sourceId": 12345
        }
    },
    "traceParent": "00-ef2d62064c7b224690a9578e84f4c617-150bbac7b6406e46-00"
}
```

--------------------------------

### Get Photobook Spine Details

Source: https://www.prodigi.com/print-api/docs/reference

This endpoint returns the required width of the book spine for a book with the provided number of pages going to a particular destination country.

```APIDOC
## Get Photobook Spine Details

### Description
Calculates the required spine width for a photobook based on its specifications and destination.

### Method
POST

### Endpoint
/v4.0/products/spine

### Parameters
#### Request Body
- **sku** (string) - Required - The SKU of the photobook.
- **destinationCountryCode** (string) - Required - The two-letter country code for the destination.
- **state** (string) - Optional - The state or province code for the destination (if applicable).
- **numberOfPages** (integer) - Required - The total number of pages in the photobook.

### Request Example
```json
{
    "sku": "BOOK-A4-L-HARD-M",
    "destinationCountryCode": "US",
    "state": "CA",
    "numberOfPages": 50
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **message** (string) - A message indicating the result or any errors.
- **spineInfo** (object) - Contains information about the book spine.
  - **widthMm** (number) - The calculated width of the book spine in millimeters.

#### Response Example
```json
{
    "success": true,
    "message": "Spine info retrieved (or appropriate error message)",
    "spineInfo": {
        "widthMm": 25.4
    }
}
```
```

--------------------------------

### Callback Data Object Example

Source: https://www.prodigi.com/print-api/docs/reference

This snippet shows a simplified version of the 'data' object within a callback payload, focusing on the order ID, creation timestamp, and current status stage.

```json
 {
      "id": "ord_1469466",
      "created": "2020-08-14T11:50:54.557Z",
      "status": {
        "stage": "InProgress"
      }
 }
```

--------------------------------

### Get Photobook Spine Details

Source: https://www.prodigi.com/print-api/docs/reference

Calculate the required photobook spine width based on SKU, destination, and number of pages. Replace 'your-api-key' with your actual API key.

```curl
curl "https://api.prodigi.com/v4.0/products/spine" \
  -X POST \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '
    {
        "sku": "BOOK-A4-L-HARD-M",
        "destinationCountryCode": "US",
        "state": "CA",
        "numberOfPages": 50
    }

'
```

--------------------------------

### Example API Response with Order Details

Source: https://www.prodigi.com/print-api/docs/reference

This JSON structure represents a successful order creation response, including order details, status, and item information. The 'outcome' field indicates the result of the request.

```json
{
    "outcome": "Created",
    "order": {
        "id": "ord_840796",
        "created": "2021-03-11T14:31:23.41Z",
        "lastUpdated": "2021-03-11T14:31:23.4931606Z",
        "callbackUrl": null,
        "merchantReference": "MyMerchantReference1",
        "shippingMethod": "Overnight",
        "idempotencyKey": null,
        "status": {
            "stage": "InProgress",
            "issues": [],
            "details": {
                "downloadAssets": "NotStarted",
                "printReadyAssetsPrepared": "NotStarted",
                "allocateProductionLocation": "NotStarted",
                "inProduction": "NotStarted",
                "shipping": "NotStarted"
            }
        },
        "charges": [],
        "shipments": [],
        "recipient": {
            "name": "Mr test",
            "email": null,
            "phoneNumber": null,
            "address": {
                "line1": "14 test place",
                "line2": "test",
                "postalOrZipCode": "12345",
                "countryCode": "US",
                "townOrCity": "somewhere",
                "stateOrCounty": null
            }
        },
        "items": [
            {
                "id": "ori_926886",
                "status": "NotYetDownloaded",
                "merchantReference": "item #1",
                "sku": "GLOBAL-CFPM-16X20",
                "copies": 1,
                "sizing": "fillPrintArea",
                "attributes": {
                    "color": "black"
                },
                "assets": [
                    {
                        "id": "ast_114059",
                        "printArea": "default",
                        "md5Hash": "daa1c811c6038e718a23f0d816914b7b",
                        "url": "https://pwintyimages.blob.core.windows.net/samples/stars/test-sample-grey.png",
                        "status": "InProgress"
                    }
                ],
                "recipientCost": {
                    "amount": "10.74",
                    "currency": "GBP"
                }
            }
        ],
        "packingSlip": null,
        "metadata": {
            "mycustomkey": "some-guid",
            "someCustomerPreference": {
                "preference1": "something",
                "preference2": "red"
            },
            "sourceId": 12345
        }
    },
    "traceParent": "00-65e25206c6b1e34dbdcea1a7051f85bd-f6885faf442b6041-00"
}
```

--------------------------------

### Get a list of orders

Source: https://www.prodigi.com/print-api/docs/reference

Use this endpoint to retrieve a list of orders. All filtering options are optional; if none are provided, default values are used. Results are sorted by Prodigi order ID in descending order.

```curl
curl "https://api.sandbox.prodigi.com/v4.0/orders" \
  -X GET \
  -H "X-API-Key: your-api-key"
```

--------------------------------

### GET /websites/prodigi_print-api/status

Source: https://www.prodigi.com/print-api/docs/reference

Retrieves the current status of an order, including its stage, processing details, and any associated issues.

```APIDOC
## GET /websites/prodigi_print-api/status

### Description
Retrieves the current status of an order, including its stage, processing details, and any associated issues.

### Method
GET

### Endpoint
/websites/prodigi_print-api/status

### Parameters
#### Query Parameters
- **orderId** (string) - Required - The unique identifier of the order.

### Response
#### Success Response (200)
- **stage** (string) - The current stage of the order. Possible values: `InProgress`, `Complete`, `Cancelled`.
- **details** (object) - An object containing the status of each processing stage.
  - **downloadAssets** (string) - Status of asset download. Possible values: `NotStarted`, `InProgress`, `Complete`, `Error`.
  - **printReadyAssetsPrepared** (string) - Status of print-ready asset preparation. Possible values: `NotStarted`, `InProgress`, `Complete`, `Error`.
  - **allocateProductionLocation** (string) - Status of production location allocation. Possible values: `NotStarted`, `InProgress`, `Complete`, `Error`.
  - **inProduction** (string) - Status of the item being in production. Possible values: `NotStarted`, `InProgress`, `Complete`, `Error`.
  - **shipping** (string) - Status of the item shipping. Possible values: `NotStarted`, `InProgress`, `Complete`, `Error`.
- **issues** (array) - An array of issue objects if any problems are encountered.
  - **objectId** (string) - The ID of the object (order or item) with the issue.
  - **errorCode** (string) - A code indicating the type of error.
  - **description** (string) - A human-readable description of the error.
  - **authorisationDetails** (object) - Details for payment authorization if required.
    - **authorisationUrl** (string) - The URL for payment authorization.
    - **paymentDetails** (object) - Details of the payment required.
      - **amount** (string) - The payment amount.
      - **currency** (string) - The currency of the payment.

#### Response Example
```json
{
    "stage":"InProgress",
    "details" : {
        "downloadAssets":"InProgress",
        "printReadyAssetsPrepared":"NotStarted",
        "allocateProductionLocation ": "NotStarted",
        "inProduction":"NotStarted",
        "shipping":"NotStarted"
    },
    "issues":[
        {
            "objectId": "ori_12345",
            "errorCode" : "items.assets.NotDownloaded",
            "description" : "Warning: Download attempt 1 of 10 failed for 'default' asset on item 'ori_12345' at location 'http://source.url' "
        },
        {
            "objectId": "ord_829398",
            "errorCode": "RequiresPaymentAuthorisation",
            "description": "Payment authorisation required for 'ord_829398' (195.02USD) please use the following URL to make payment: https://beta-dashboard.pwinty.com/payment/97323",
            "authorisationDetails": {
                "authorisationUrl": "https://beta-dashboard.pwinty.com/payment/97323",
                "paymentDetails": {
                    "amount": "195.02",
                    "currency": "USD"
                }
            }
        }
    ]
}
```
```

--------------------------------

### GET /v4.0/Orders

Source: https://www.prodigi.com/print-api/docs/reference

Retrieves a list of orders. This endpoint is used to fetch order information from the Prodigi system.

```APIDOC
## GET /v4.0/Orders

### Description
Retrieves a list of orders. This endpoint is used to fetch order information from the Prodigi system.

### Method
GET

### Endpoint
/v4.0/Orders

### Parameters
#### Query Parameters
- **merchantReference** (string) - Optional - Filter orders by merchant reference.
- **status** (string) - Optional - Filter orders by their current status.

### Response
#### Success Response (200)
- **orders** (array) - An array of order objects.
  - **id** (string) - The unique identifier for the order.
  - **created** (string) - The date and time the order was created.
  - **lastUpdated** (string) - The date and time the order was last updated.
  - **merchantReference** (string) - A reference identifier provided by the merchant.
  - **status** (object) - The current status of the order.
    - **stage** (string) - The current stage of the order (e.g., InProgress, Completed).
    - **details** (object) - Detailed breakdown of the order status.
  - **recipient** (object) - Information about the order recipient.
    - **name** (string) - The name of the recipient.
    - **address** (object) - The shipping address for the order.
      - **line1** (string) - The first line of the address.
      - **postalOrZipCode** (string) - The postal or ZIP code.
      - **countryCode** (string) - The two-letter country code.
      - **townOrCity** (string) - The town or city.
  - **items** (array) - An array of items included in the order.
    - **sku** (string) - The Stock Keeping Unit for the item.
    - **copies** (integer) - The number of copies of the item.
    - **assets** (array) - An array of assets associated with the item.
      - **url** (string) - The URL of the asset.
      - **printArea** (string) - The print area for the asset.

#### Response Example
```json
{
    "orders": [
        {
            "id": "ord_840796",
            "created": "2021-03-11T14:31:23.41Z",
            "lastUpdated": "2021-03-11T14:31:23.4931606Z",
            "merchantReference": "MyMerchantReference1",
            "status": {
                "stage": "InProgress",
                "details": {}
            },
            "recipient": {
                "name": "Mr test",
                "address": {
                    "line1": "14 test place",
                    "postalOrZipCode": "12345",
                    "countryCode": "US",
                    "townOrCity": "somewhere"
                }
            },
            "items": [
                {
                    "sku": "GLOBAL-CFPM-16X20",
                    "copies": 1,
                    "assets": [
                        {
                            "url": "https://pwintyimages.blob.core.windows.net/samples/stars/test-sample-grey.png",
                            "printArea": "default"
                        }
                    ]
                }
            ]
        }
    ]
}
```
```

--------------------------------

### Get Orders API

Source: https://www.prodigi.com/print-api/docs/reference

Retrieves a list of orders with optional filtering. Results are sorted by Prodigi order ID in descending order.

```APIDOC
## Get orders

### Description
This endpoint returns a list of Orders for the given filtering options. All of these options are optional. If none are provided, their defaults will be used. Results are sorted by Prodigi order ID (descending).

### Method
GET

### Endpoint
/v4.0/orders

### Query Parameters
- **top** (int) - Optional - Number of orders to return. Must be 1–100. Default: 10
- **skip** (int) - Optional - Number of records to skip before the next `top` worth of orders. Must be greater than or equal to 0. Default: 0
- **createdFrom** (datetime) - Optional - Limit to orders placed after this date/time (UTC). Can be used without `createdTo`.
- **createdTo** (datetime) - Optional - Limit to orders placed before this date/time (UTC). Can be used without `createdFrom`.
- **status** (string) - Optional - Limit to a particular status. Valid `status` values are `draft`, `awaitingPayment`, `inProgress`, `complete`, `cancelled`. Default: null
- **orderIds** (array) - Optional - Limit to a list of Prodigi order IDs. Default: null
- **merchantReferences** (array) - Optional - Limit to a range of your order references. Default: null

### Request Example
```json
{
  "example": "curl \"https://api.sandbox.prodigi.com/v4.0/orders\" \
  -X GET \
  -H \"X-API-Key: your-api-key\""
}
```

### Response
#### Success Response (200)
- **orders** (array of Orders) - Each `order` is identical to that returned by Get Order by ID.
- **hasMore** (boolean) - True if there are more results available.
- **nextUrl** (string) - If `HasMore` is true, contains the full URL to the next page of orders.

#### Response Example
```json
{
    "outcome": "Ok",
    "orders": [
        {
            "id": "ord_840797",
            "// rest of the order": "// rest of the order"
        },
        {
            "id": "ord_839555",
            "// rest of the order": "// rest of the order"
        },
        {
            "id": "ord_838659",
            "// rest of the order": "// rest of the order"
        },
        {
            "id": "ord_838055",
            "// rest of the order": "// rest of the order"
        }
    ],
    "hasMore": true,
    "nextUrl": "https://api.sandbox.prodigi.com/v4.0/Orders?Skip=10",
    "traceParent": "00-cb879e84d8c70a45b5742d34be5f3a6d-4535bc8797a33c49-00"
}
```

### Error Handling
- **ok** (200): The request was understood and a relevant response was returned.
```

--------------------------------

### Create Order Request

Source: https://www.prodigi.com/print-api/docs/reference

Use this cURL command to send a POST request to create a new order. Ensure you replace 'your-api-key' with your actual API key and adjust the JSON payload as needed.

```bash
curl "https://api.sandbox.prodigi.com/v4.0/Orders" \
  -X POST \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '
    {
        "merchantReference": "MyMerchantReference1",
        "shippingMethod": "Overnight",
        "recipient": {
            "name": "Mr Testy McTestface",
            "address": {
                "line1": "14 test place",
                "line2": "test",
                "postalOrZipCode": "12345",
                "countryCode": "US",
                "townOrCity": "somewhere",
                "stateOrCounty": null
            }
        },
        "branding": {
            "postcard": { "url" : "https://sample/postcard.jpg"},
            "flyer": { "url" : "https://sample/flyer.pdf"},
            "packing_slip_bw": { "url" : "https://sample/delivery_note_bw.jpg"},
            "packing_slip_color" : { "url" : "https://sample/delivery_note_color.jpg"},
            "sticker_exterior_round" : { "url" : "https://sample/sticker_round.jpg"},
            "sticker_exterior_rectangle"  :{ "url" : "https://sample/sticker_rect.jpg"},
            "sticker_interior_round" : { "url" : "https://sample/sticker_round.jpg"},
            "sticker_interior_rectangle": { "url" : "https://sample/sticker_rect.jpg"}
        },
        "items": [
            {
                "merchantReference": "item #1",
                "sku": "GLOBAL-CFPM-16X20",
                "copies": 1,
                "sizing": "fillPrintArea",
                "attributes": {
                    "color": "black"
                },
                "recipientCost": {
                    "amount": "15.00",
                    "currency": "USD"
                },
                "assets": [
                    {
                        "printArea": "default",
                        "url": "https://pwintyimages.blob.core.windows.net/samples/stars/test-sample-grey.png",
                        "md5Hash": "daa1c811c6038e718a23f0d816914b7b",
                        "pageCount": 50
                    }
                ]
            }
        ],
        "metadata": {
            "mycustomkey":"some-guid",
            "someCustomerPreference": {
                "preference1": "something",
                "preference2": "red"
            },
            "sourceId": 12345
        }
    }  
  '

```

--------------------------------

### Quote API

Source: https://www.prodigi.com/print-api/docs/reference

The Quote endpoint allows you to get pricing and shipping information about a given set of products without creating an order.

```APIDOC
## Quotes

### Description
The Quote endpoint allows you to get pricing and shipping information about a given set of products without creating an order. It returns how the order will be fulfilled, including:
  * The fulfillment location
  * The cost of the products
  * The cost of shipping
  * The couriers of each shipment
```

--------------------------------

### Product Details Object Structure

Source: https://www.prodigi.com/print-api/docs/reference

This JSON object represents the full details of a product, including its SKU, description, dimensions, attributes, print areas, and available variants. Use this endpoint to fetch all necessary information for a specific product.

```json
{
    "sku": "GLOBAL-CAN-10X10",
    "description": "Standard canvas on quality stretcher bar, 25x25cm",
    "productDimensions": {
        "width": 10.0000,
        "height": 10.0000,
        "units": "in"
    },
    "attributes": {
        "wrap": [
            "Black",
            "ImageWrap",
            "MirrorWrap",
            "White"
        ]
    },
    "printAreas": {
        "default": {
            "required": true
        }
    },
    "variants": [
        {
            "attributes": {
                "wrap": "Black"
            },
            "shipsTo": [
                "IM",
                "LU",
                "ID",
                "CI",
                "GR",
                "FK",
                "AL",
                "LA",
                "KY"
            ],
            "printAreaSizes": {
                "default": {
                    "horizontalResolution": 1522,
                    "verticalResolution": 1522
                }
            }
        },
        {
            "attributes": {
                "wrap": "ImageWrap"
            },
            "shipsTo": [
                "IM",
                "LU",
                "ID",
                "CI",
                "GR",
                "FK",
                "AL",
                "LA",
                "KY"
            ],
            "printAreaSizes": {
                "default": {
                    "horizontalResolution": 2137,
                    "verticalResolution": 2137
                }
            }
        },
        {
            "attributes": {
                "wrap": "MirrorWrap"
            },
            "shipsTo": [
                "IM",
                "LU",
                "ID",
                "CI",
                "GR",
                "FK",
                "AL",
                "LA",
                "KY"
            ],
            "printAreaSizes": {
                "default": {
                    "horizontalResolution": 1522,
                    "verticalResolution": 1522
                }
            }
        },
        {
            "attributes": {
                "wrap": "White"
            },
            "shipsTo": [
                "IM",
                "LU",
                "ID",
                "CI",
                "GR",
                "FK",
                "AL",
                "LA",
                "KY"
            ],
            "printAreaSizes": {
                "default": {
                    "horizontalResolution": 1522,
                    "verticalResolution": 1522
                }
            }
        }
    ]
}
```
Tokens:
Raw