Orders

Orders APIs

This API allows you to make HTTP requests to manage orders and products.

Order constants

These are the states that an order can have during it's lifecycle:

  • waiting_execute_payment
  • pending_payment
  • paid
  • in_processing
  • closed
  • canceled
  • deleted

Product constants

These are the states that a product can have during it's lifecycle:

  • waiting_execute_payment
  • pending
  • waiting_upload_confirmation
  • waiting_file_check
  • in_processing
  • waiting_upload
  • shipped
  • canceled
  • deleted

These are the manufacturing time codes with the corresponding duration in days:

  • economy: 8 days
  • standard: 5 days
  • express: 2 days

Retrieve all orders

  • URL: /v1/reseller/orders
  • Method: GET
  • Header: Authorization. To make a valid request you need to be authenticated using access token. For more info see authentication
  • URL Params:
    • page: used to paginate results, starts from zero (0)
    • limit: used to get a limited number of results
    • sort: used to specify the sorting order of the results (ascending or descending)
  • Data params: none
  • Response: the response will be provided with content type application/json and will contain the following fields:
    • request: an object that contains all data you used on your HTTP request and it will contain the following fields:
      • uri: the URI you used to make the HTTP request
      • method: the HTTP method, e.g. GET
      • query: an object containing all the parameters and the related values you used to make the HTTP request
    • response: an array of objects where each object is an order made by the following fields:
      • id: a string representing the order id
      • purchase_order: a string representing the purchase order
      • total_amount_tax_excluded: the total amount tax excluded of the order in EUR
      • total_amount_tax_included: the total amount tax included of the order in EUR
      • tax_amount: the tax amount of the order
      • status: the order status
      • items: an array of object where each object is a product made by the following fields:
        • id: a string representing the product id
        • article: the box code
        • width: the width of the box
        • depth: the depth of the box
        • height: the height of the box
        • material: the material code
        • references: an array of objects where each object is a reference made by the following fields:
          • quantity: the number of boxes of the reference
        • printing: CMYK printing
        • gold: gold finishing
        • silver: silver finishing
        • varnish: varnish finishing
        • status: the product status
        • manufacturing_time: a manufacturing time code
        • total_amount_tax_excluded: the total amount tax excluded of the product in EUR
        • total_amount_tax_included: the total amount tax included of the product in EUR
      • shipping: an object representing the shipping address of the order:
        • first_name: first name
        • last_name: last name
        • company: company name
        • co: co
        • phone: phone number
        • country_code: an ISO code of the country
        • province: province name
        • city: city name
        • zip_code: zip code
        • address: address name
      • billing: an object representing the billing address of the order:
        • first_name: first name
        • last_name: last name
        • company: company name
        • co: co
        • phone: phone number
        • country_code: an ISO code of the country
        • province: province name
        • city: city name
        • zip_code: zip code
        • address: address name

Errors

The errors raised by this endpoint can be of the following types:

  • VALIDATION_ERROR
    • ORD_1100: page is required
    • ORD_1101: limit is required
    • ORD_1102: sort is required
  • INTERNAL_SERVER_ERROR
    • for this type of errors, please refer to the errors page
  • NOT_FOUND
    • for this type of errors, please refer to the errors page

Examples

Request

GET /v1/reseller/orders HTTP/1.1
Authorization: Bearer eHZ6MWV2R ... o4OERSZHlPZw==
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
 
page=1
limit=2

Response

HTTP status code: 200

{
  "request": {
    "uri": "/v1/reseller/orders",
    "method": "GET",
    "query": {
      "page": "1",
      "limit": "2"
    }
  },
  "response": [
    {
      "id": "2023-1679911-7562560",
      "total_amount_tax_excluded": 57.19,
      "total_amount_tax_included": 69.77,
      "tax_amount": 12.58,
      "status": "paid",
      "items": [
        {
          "id": "2023-1679911-7562560.01",
          "article": "s001_v0",
          "width": 80,
          "depth": 80,
          "height": 150,
          "material": "SBS300",
          "references": [
            {
              "quantity": 25
            }
          ],
          "printing": true,
          "gold": false,
          "silver": false,
          "varnish": false,
          "status": "waiting_upload",
          "manufacturing_time": "economy",
          "total_amount_tax_excluded": 57.19,
          "total_amount_tax_included": 69.77
        }
      ],
      "shipping": {
        "first_name": "First Name",
        "last_name": "Last Name",
        "company": "Company name",
        "co": "co",
        "phone": "123456789",
        "country_code": "IT",
        "province": "Province name",
        "city": "City name",
        "zip_code": "ZIP code",
        "address": "Address name"
      },
      "billing": {
        "first_name": "First Name",
        "last_name": "Last Name",
        "company": "Company name",
        "co": "co",
        "phone": "123456789",
        "country_code": "IT",
        "province": "Province name",
        "city": "City name",
        "zip_code": "ZIP code",
        "address": "Address name"
      }
    },
    {
      "id": "2023-1680605-5618609",
      "total_amount_tax_excluded": 283.67,
      "total_amount_tax_included": 346.08,
      "tax_amount": 62.41,
      "status": "paid",
      "items": [
        {
          "id": "2023-1680605-5618609.01",
          "article": "s001_v0",
          "width": 80,
          "depth": 80,
          "height": 150,
          "material": "SBS300",
          "references": [
            {
              "quantity": 25
            }
          ],
          "printing": true,
          "gold": false,
          "silver": false,
          "varnish": false,
          "status": "waiting_upload",
          "manufacturing_time": "economy",
          "total_amount_tax_excluded": 57.19,
          "total_amount_tax_included": 69.77
        },
        {
          "id": "2023-1680605-5618609.02",
          "article": "s002_v4",
          "width": 150,
          "depth": 100,
          "height": 40,
          "material": "SBS300",
          "references": [
            {
              "quantity": 25
            }
          ],
          "printing": true,
          "gold": false,
          "silver": false,
          "varnish": false,
          "status": "waiting_upload",
          "manufacturing_time": "economy",
          "total_amount_tax_excluded": 54.91,
          "total_amount_tax_included": 66.99
        },
        {
          "id": "2023-1680605-5618609.03",
          "article": "s001_v1",
          "width": 80,
          "depth": 80,
          "height": 150,
          "material": "SBS300",
          "references": [
            {
              "quantity": 25
            }
          ],
          "printing": true,
          "gold": false,
          "silver": false,
          "varnish": false,
          "status": "waiting_upload",
          "manufacturing_time": "economy",
          "total_amount_tax_excluded": 57.19,
          "total_amount_tax_included": 69.77
        },
        {
          "id": "2023-1680605-5618609.04",
          "article": "s001_v0",
          "width": 80,
          "depth": 80,
          "height": 150,
          "material": "SBS300",
          "references": [
            {
              "quantity": 25
            }
          ],
          "printing": true,
          "gold": false,
          "silver": false,
          "varnish": false,
          "status": "waiting_upload",
          "manufacturing_time": "economy",
          "total_amount_tax_excluded": 57.19,
          "total_amount_tax_included": 69.77
        },
        {
          "id": "2023-1680605-5618609.05",
          "article": "s001_v1",
          "width": 80,
          "depth": 80,
          "height": 150,
          "material": "SBS300",
          "references": [
            {
              "quantity": 25
            }
          ],
          "printing": true,
          "gold": false,
          "silver": false,
          "varnish": false,
          "status": "waiting_upload",
          "manufacturing_time": "economy",
          "total_amount_tax_excluded": 57.19,
          "total_amount_tax_included": 69.77
        }
      ],
      "shipping": {
        "first_name": "First Name",
        "last_name": "Last Name",
        "company": "Company name",
        "co": "co",
        "phone": "123456789",
        "country_code": "IT",
        "province": "Province name",
        "city": "City name",
        "zip_code": "ZIP code",
        "address": "Address name"
      },
      "billing": {
        "first_name": "First Name",
        "last_name": "Last Name",
        "company": "Company name",
        "co": "co",
        "phone": "123456789",
        "country_code": "IT",
        "province": "Province name",
        "city": "City name",
        "zip_code": "ZIP code",
        "address": "Address name"
      }
    }
  ]
}

Create an order

  • URL: /v1/reseller/orders
  • Method: POST
  • Header: Authorization. To make a valid request you need to be authenticated using access token. For more info see authentication
  • URL params: none
  • Data params:
    • body: A json object with this structure
      • purchase_order(optional): a string representing the purchase order
      • items: an array of object where each object is a product made by the following fields:
        • article: the box type you want to generate, e.g. s020_v1. For more info see articles
        • material: the type of material used to print the box, e.g. SBS300. For more info see materials
        • width: the width of the box e.g. 65 in millimeters. The width must be a numeric value with max precision set to two decimal places
        • depth: the depth of the box e.g. 65 in millimeters. The depth must be a numeric value with max precision set to two decimal places
        • height: the height of the box e.g. 75 in millimeters. The height must be a numeric value with max precision set to two decimal places
        • references : an array of objects where each object is a reference made by the following fields:
          • quantity: the number of boxes of the reference
        • printing: a boolean value to set the CMYK printing
        • gold: a boolean value to set the gold finishing
        • silver: a boolean value to set the silver finishing
        • varnish: a boolean value to set the varnish finishing
        • manufacturing_time: a string indicating the manufacturing time speed
    • shipping: an object representing the shipping address of the order:
      • first_name: a string representing the first name
      • last_name: a string representing the last name
      • company: a string representing the company name
      • co: a string representing the co
      • phone: a string representing the phone number
      • country_code: a two character ISO code representing the shipping country
      • province: a string representing the province name
      • city: a string representing the city name
      • zip_code: a string representing the zip code
      • address: a string representing the address name
  • Response: the response will be provided with content type application/json and will contain the following fields:
    • request: an object that contains all data you used on your HTTP request and it will contain the following fields:
      • uri: the URI you used to make the HTTP request
      • method: the HTTP method, e.g. GET
      • query: an object containing all the parameters and the related values you used to make the HTTP request
    • response: an object representing the created order:
      • id: a string representing the order id
      • purchase_order: a string representing the purchase order
      • total_amount_tax_excluded: the total amount tax excluded of the order in EUR
      • total_amount_tax_included: the total amount tax included of the order in EUR
      • tax_amount: the tax amount of the order
      • status: the order status
      • items: an array of object where each object is a product made by the following fields:
        • id: a string representing the product id
        • article: the box code
        • width: the width of the box
        • depth: the depth of the box
        • height: the height of the box
        • material: the material code
        • references: an array of objects where each object is a reference made by the following fields:
          • quantity: the number of boxes of the reference
        • printing: CMYK printing
        • gold: gold finishing
        • silver: silver finishing
        • varnish: varnish finishing
        • status: the product status
        • manufacturing_time: a manufacturing time code
        • total_amount_tax_excluded: the total amount tax excluded of the product in EUR
        • total_amount_tax_included: the total amount tax included of the product in EUR
      • shipping: an object representing the shipping address of the order:
        • first_name: first name
        • last_name: last name
        • company: company name
        • co: co
        • phone: phone number
        • country_code: an ISO code of the country
        • province: province name
        • city: city name
        • zip_code: zip code
        • address: address name
      • billing: an object representing the billing address of the order:
        • first_name: first name
        • last_name: last name
        • company: company name
        • co: co
        • phone: phone number
        • country_code: an ISO code of the country
        • province: province name
        • city: city name
        • zip_code: zip code
        • address: address name

Errors

The errors raised by this endpoint can be of the following types:

  • VALIDATION_ERROR
    • ORD_1103: purchase_order is required
    • ORD_1104: items is required
    • ORD_1105: article must be a valid article code
    • ORD_1106: material must be a valid material code
    • ORD_1107: width is required and must be a positive number with no more than two decimal places
    • ORD_1108: depth is required and must be a positive number with no more than two decimal places
    • ORD_1109: height is required and must be a positive number with no more than two decimal places
    • ORD_1110: references is required
    • ORD_1111: quantity is required and must be a integer positive number
    • ORD_1112: printing must be a boolean value
    • ORD_1113: gold must be a boolean value or its value it's not allowed in this configuration
    • ORD_1114: silver must be a boolean value or its value it's not allowed in this configuration
    • ORD_1115: varnish must be a boolean value or its value it's not allowed in this configuration
    • ORD_1116: manufacturing_time must be a valid manufacturing_time code
    • ORD_1117: shipping is required
    • ORD_1118: first_name must be a string
    • ORD_1119: last_name must be a string
    • ORD_1120: company must be a string
    • ORD_1121: co must be a string
    • ORD_1122: phone must be a string
    • ORD_1123: country_code must be a valid iso code
    • ORD_1124: province must be a string
    • ORD_1125: city must be a string
    • ORD_1126: zip_code must be a string
    • ORD_1127: address must be a string
  • QUANTITY_ERROR
    • ORD_1134: the number of sheets doesn't reach the minimum required quantity
  • BOX_ERROR
    • for this type of errors, please refer to the errors page
  • INTERNAL_SERVER_ERROR
    • for this type of errors, please refer to the errors page
  • NOT_FOUND
    • for this type of errors, please refer to the errors page

Examples

Request

POST /v1/reseller/orders HTTP/1.1
Authorization: Bearer eHZ6MWV2R ... o4OERSZHlPZw==
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
 
body
{
  "purchase_order": "purchase_order",
  "items": [
    {
      "article": "s001_v0",
      "material": "FBB285",
      "width": 70.66,
      "depth": 80.77,
      "height": 120,
      "references": [
        {
          "quantity": 3000
        }
      ],
      "printing": false,
      "gold": false,
      "silver": false,
      "varnish": false,
      "manufacturing_time": "standard"
    },
    {
      "article": "s001_v1",
      "material": "SBS300",
      "width": 70.66,
      "depth": 80.77,
      "height": 120,
      "references": [
        {
          "quantity": 100
        }
      ],
      "printing": true,
      "gold": false,
      "silver": true,
      "varnish": false,
      "manufacturing_time": "express"
    }
  ],
  "shipping": {
    "first_name": "First Name",
    "last_name": "Last Name",
    "company": "Company name",
    "co": "co",
    "phone": "123456789",
    "country_code": "IT",
    "province": "Province name",
    "city": "City name",
    "zip_code": "ZIP code",
    "address": "Address name"
  }
}

Response

HTTP status code: 200

{
  "request": {
    "uri": "/v1/reseller/orders",
    "method": "POST",
    "body": {
      "purchase_order": "purchase_order",
      "items": [
        {
          "article": "s001_v0",
          "material": "FBB285",
          "width": 70.66,
          "depth": 80.77,
          "height": 120,
          "references": [
            {
              "quantity": 3000
            }
          ],
          "printing": false,
          "gold": false,
          "silver": false,
          "varnish": false,
          "manufacturing_time": "standard"
        },
        {
          "article": "s001_v1",
          "material": "SBS300",
          "width": 70.66,
          "depth": 80.77,
          "height": 120,
          "references": [
            {
              "quantity": 100
            }
          ],
          "printing": true,
          "gold": false,
          "silver": true,
          "varnish": false,
          "manufacturing_time": "express"
        }
      ],
      "shipping": {
        "first_name": "First Name",
        "last_name": "Last Name",
        "company": "Company name",
        "co": "co",
        "phone": "123456789",
        "country_code": "IT",
        "province": "Province name",
        "city": "City name",
        "zip_code": "ZIP code",
        "address": "Address name"
      }
    }
  },
  "response": {
    "id": "2024-1724415-8887275",
    "purchase_order": "purchase_order",
    "total_amount_tax_excluded": 1116.86,
    "total_amount_tax_included": 1362.56,
    "tax_amount": 245.7,
    "status": "pending_payment",
    "items": [
      {
        "id": "2024-1724415-8887275.01",
        "article": "s001_v0",
        "width": 70.66,
        "depth": 80.77,
        "height": 120,
        "material": "FBB285",
        "references": [
          {
            "quantity": 3000
          }
        ],
        "printing": false,
        "gold": false,
        "silver": false,
        "varnish": false,
        "status": "in_processing",
        "manufacturing_time": "standard",
        "total_amount_tax_excluded": 752.65,
        "total_amount_tax_included": 918.23
      },
      {
        "id": "2024-1724415-8887275.02",
        "article": "s001_v1",
        "width": 70.66,
        "depth": 80.77,
        "height": 120,
        "material": "SBS300",
        "references": [
          {
            "quantity": 100
          }
        ],
        "printing": true,
        "gold": false,
        "silver": true,
        "varnish": false,
        "status": "waiting_upload",
        "manufacturing_time": "express",
        "total_amount_tax_excluded": 364.21,
        "total_amount_tax_included": 444.33
      }
    ],
    "shipping": {
      "first_name": "First Name",
      "last_name": "Last Name",
      "company": "Company name",
      "co": "co",
      "phone": "123456789",
      "country_code": "IT",
      "province": "Province name",
      "city": "City name",
      "zip_code": "ZIP code",
      "address": "Address name"
    },
    "billing": {
      "first_name": "First Name",
      "last_name": "Last Name",
      "company": "Company name",
      "co": "co",
      "phone": "123456789",
      "country_code": "IT",
      "province": "Province name",
      "city": "City name",
      "zip_code": "ZIP code",
      "address": "Address name"
    }
  }
}

Retrieve a specific order

  • URL: /v1/reseller/orders/:order_id
  • Method: GET
  • Header: Authorization. To make a valid request you need to be authenticated using access token. For more info see authentication
  • URL segments:
    • order_id: This field represents an order in the form of a reference number 2018-1533201-3892461
  • Data params: none
  • Response: the response will be provided with content type application/json and will contain the following fields:
    • request: an object that contains all data you used on your HTTP request and it will contain the following fields:
      • uri: the URI you used to make the HTTP request
      • method: the HTTP method, e.g. GET
      • query: an object containing all the parameters and the related values you used to make the HTTP request
    • response: an object made by the following fields:
      • id: a string representing the order id
      • purchase_order: a string representing the purchase order
      • total_amount_tax_excluded: the total amount tax excluded of the order in EUR
      • total_amount_tax_included: the total amount tax included of the order in EUR
      • tax_amount: the tax amount of the order
      • status: the order status
      • items: an array of object where each object is a product made by the following fields:
        • id: a string representing the product id
        • article: the box code
        • width: the width of the box
        • depth: the depth of the box
        • height: the height of the box
        • material: the material code
        • references: an array of objects where each object is a reference made by the following fields:
          • quantity: the number of boxes of the reference
        • printing: CMYK printing
        • gold: gold finishing
        • silver: silver finishing
        • varnish: varnish finishing
        • status: the product status
        • manufacturing_time: a manufacturing time code
        • total_amount_tax_excluded: the total amount tax excluded of the product in EUR
        • total_amount_tax_included: the total amount tax included of the product in EUR
      • shipping: an object representing the shipping address of the order:
        • first_name: first name
        • last_name: last name
        • company: company name
        • co: co
        • phone: phone number
        • country_code: an ISO code of the country
        • province: province name
        • city: city name
        • zip_code: zip code
        • address: address name
      • billing: an object representing the billing address of the order:
        • first_name: first name
        • last_name: last name
        • company: company name
        • co: co
        • phone: phone number
        • country_code: an ISO code of the country
        • province: province name
        • city: city name
        • zip_code: zip code
        • address: address name

Errors

The errors raised by this endpoint can be of the following types:

  • ORDER_ERROR
    • for this type of errors, please refer to the errors page
  • INTERNAL_SERVER_ERROR
    • for this type of errors, please refer to the errors page
  • NOT_FOUND
    • for this type of errors, please refer to the errors page

Examples

Request

GET /v1/reseller/orders/2024-1724415-8887275 HTTP/1.1
Authorization: Bearer eHZ6MWV2R ... o4OERSZHlPZw==
Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Response

HTTP status code: 200

{
  "request": {
    "uri": "/v1/reseller/orders/2024-1724415-8887275",
    "method": "GET",
    "params": {
      "orderId": "2024-1724415-8887275"
    }
  },
  "response": {
    "id": "2024-1724415-8887275",
    "purchase_order": "purchase_order",
    "total_amount_tax_excluded": 1116.86,
    "total_amount_tax_included": 1362.56,
    "tax_amount": 245.7,
    "status": "pending_payment",
    "items": [
      {
        "id": "2024-1724415-8887275.01",
        "article": "s001_v0",
        "width": 70.66,
        "depth": 80.77,
        "height": 120,
        "material": "FBB285",
        "references": [
          {
            "quantity": 3000
          }
        ],
        "printing": false,
        "gold": false,
        "silver": false,
        "varnish": false,
        "status": "in_processing",
        "manufacturing_time": "standard",
        "total_amount_tax_excluded": 752.65,
        "total_amount_tax_included": 918.23
      },
      {
        "id": "2024-1724415-8887275.02",
        "article": "s001_v1",
        "width": 70.66,
        "depth": 80.77,
        "height": 120,
        "material": "SBS300",
        "references": [
          {
            "quantity": 100
          }
        ],
        "printing": true,
        "gold": false,
        "silver": true,
        "varnish": false,
        "status": "waiting_upload",
        "manufacturing_time": "express",
        "total_amount_tax_excluded": 364.21,
        "total_amount_tax_included": 444.33
      }
    ],
    "shipping": {
      "first_name": "First Name",
      "last_name": "Last Name",
      "company": "Company name",
      "co": "co",
      "phone": "123456789",
      "country_code": "IT",
      "province": "Province name",
      "city": "City name",
      "zip_code": "ZIP code",
      "address": "Address name"
    },
    "billing": {
      "first_name": "First Name",
      "last_name": "Last Name",
      "company": "Company name",
      "co": "co",
      "phone": "123456789",
      "country_code": "IT",
      "province": "Province name",
      "city": "City name",
      "zip_code": "ZIP code",
      "address": "Address name"
    }
  }
}

Retrieve a specific product

  • URL: /v1/reseller/orders/:order_id/products/:product_id
  • Method: GET
  • Header: Authorization. To make a valid request you need to be authenticated using access token. For more info see authentication
  • URL segments:
    • order_id: an ID in the form of a reference number, e.g. 2018-1533201-3892461
    • product_id: a product within an order in the form of a reference number, e.g. 2018-1533201-3892461.01
  • Data params: none
  • Response: the response will be provided with content type application/json and will contain the following fields:
    • request: an object that contains all data you used on your HTTP request and it will contain the following fields:
      • uri: the URI you used to make the HTTP request
      • method: the HTTP method, e.g. GET
      • query: an object containing all the parameters and the related values you used to make the HTTP request
    • response: an object that contains all the product data
      • id: a string representing the product id
      • article: the box code
      • width: the width of the box
      • depth: the depth of the box
      • height: the height of the box
      • material: the material code
      • references: an array of objects where each object is a reference made by the following fields:
        • quantity: the number of boxes of the reference
      • printing: CMYK printing
      • gold: gold finishing
      • silver: silver finishing
      • varnish: varnish finishing
      • status: the product status
      • manufacturing_time: a manufacturing time code
      • total_amount_tax_excluded: the total amount tax excluded of the product in EUR
      • total_amount_tax_included: the total amount tax included of the product in EUR

Errors

The errors raised by this endpoint can be of the following types:

  • PRODUCT_ERROR
    • for this type of errors, please refer to the errors page
  • INTERNAL_SERVER_ERROR
    • for this type of errors, please refer to the errors page
  • NOT_FOUND
    • for this type of errors, please refer to the errors page

Examples

Request

GET /v1/reseller/orders/2024-1724415-8887275/products/2024-1724415-8887275.01 HTTP/1.1
Authorization: Bearer eHZ6MWV2R ... o4OERSZHlPZw==
Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Response

HTTP status code: 200

{
  "request": {
    "uri": "/v1/reseller/orders/2024-1724415-8887275/products/2024-1724415-8887275.01",
    "method": "GET",
    "params": {
      "orderId": "2024-1724415-8887275",
      "productId": "2024-1724415-8887275.01"
    }
  },
  "response": {
    "id": "2024-1724415-8887275.01",
    "article": "s001_v0",
    "width": 70.66,
    "depth": 80.77,
    "height": 120,
    "material": "FBB285",
    "references": [
      {
        "quantity": 3000
      }
    ],
    "printing": false,
    "gold": false,
    "silver": false,
    "varnish": false,
    "status": "in_processing",
    "manufacturing_time": "standard",
    "total_amount_tax_excluded": 752.65,
    "total_amount_tax_included": 918.23
  }
}

Upload an artwork

  • URL: /v1/reseller/orders/:order_id/products/:product_id
  • Method: PUT
  • Header: Authorization. To make a valid request you need to be authenticated using access token. For more info see authentication
  • URL params:
    • order_id: an ID in the form of a reference number, e.g. 2018-1533201-3892461
    • product_id: a product within an order in the form of a reference number, e.g. 2018-1533201-3892461.01
  • Form data:
    • artwork: the file to upload. A PDF that does not exceed 500MB
  • Response: the response will be provided with content type application/json and will contain the following fields:
    • request: an object that contains all data you used on your HTTP request and it will contain the following fields:
      • uri: the URI you used to make the HTTP request
      • method: the HTTP method, e.g. GET
      • query: an object containing all the parameters and the related values you used to make the HTTP request
    • response: an object that contains all the product data
      • id: a string representing the product id
      • article: the box code
      • width: the width of the box
      • depth: the depth of the box
      • height: the height of the box
      • material: the material code
      • references: an array of objects where each object is a reference made by the following fields:
        • quantity: the number of boxes of the reference
      • printing: CMYK printing
      • gold: gold finishing
      • silver: silver finishing
      • varnish: varnish finishing
      • status: the product status
      • manufacturing_time: a manufacturing time code
      • total_amount_tax_excluded: the total amount tax excluded of the product in EUR
      • total_amount_tax_included: the total amount tax included of the product in EUR

Errors

The errors raised by this endpoint can be of the following types:

  • VALIDATION_ERROR
    • ORD_1128: artwork is required
    • ORD_1129: something wrong happened during the upload
    • ORD_1130: the number of fields exceeds the maximum allowed quantity
    • ORD_1131: the file provided exceeds the maximum allowed size
    • ORD_1132: the number of files exceeds the maximum allowed quantity
    • ORD_1133: file type not allowed
  • PRODUCT_ERROR
    • for this type of errors, please refer to the errors page
  • INTERNAL_SERVER_ERROR
    • for this type of errors, please refer to the errors page
  • NOT_FOUND
    • for this type of errors, please refer to the errors page

Examples

Request

PUT /v1/reseller/orders/2024-1724415-8887275/products/2024-1724415-8887275.02 HTTP/1.1
Authorization: Bearer eHZ6MWV2R ... o4OERSZHlPZw==
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
 
artwork=file_to_upload.pdf

Response

HTTP status code: 200

{
  "request": {
    "uri": "/v1/reseller/orders/2024-1724415-8887275/products/2024-1724415-8887275.02",
    "method": "PUT",
    "params": {
      "orderId": "2024-1724415-8887275",
      "productId": "2024-1724415-8887275.02"
    }
  },
  "response": {
    "id": "2024-1724415-8887275.02",
    "article": "s001_v1",
    "width": 70.66,
    "depth": 80.77,
    "height": 120,
    "material": "SBS300",
    "references": [
      {
        "quantity": 100
      }
    ],
    "printing": true,
    "gold": false,
    "silver": true,
    "varnish": false,
    "status": "waiting_file_check",
    "manufacturing_time": "express",
    "total_amount_tax_excluded": 364.21,
    "total_amount_tax_included": 444.33
  }
}
MaterialsQuotation