Skip to content

Create order

Use the Order create API for create an order in 1 request.

POST https://order.gelatoapis.com/v3/orders

Request example

$ curl -X POST \
   https://order.gelatoapis.com/v3/orders \
   -H 'Content-Type: application/json' \
   -H 'X-API-KEY: {{apiKey}}' \
   -d '{
        "orderReferenceId": "{{myOrderId}}",
        "customerReferenceId": "{{myCustomerId}}",
        "currency": "USD",
        "shipmentMethodUid": "express",
        "shippingAddress": {
             "country": "US",
             "companyName": "Example",
             "firstName": "Paul",
             "lastName": "Smith",
             "addressLine1": "451 Clarkson Ave",
             "addressLine2": "Brooklyn",
             "state": "NY",
             "city": "New York",
             "postСode": "11203",
             "email": "apisupport@gelato.com",
             "phone": "123456789"
         },
        "items": [
            {
                "itemReferenceId": "{{myItemId1}}",
                "productUid": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
                "fileUrl": "https://s3-eu-west-1.amazonaws.com/developers.gelato.com/product-examples/test_print_job_BX_4-4_hor_none.pdf",
                "quantity": 100
            },
            {
                "itemReferenceId": "{{myItemId2}}",
                "productUid": "cards_pf_5r_pt_100-lb-cover-coated-silk_cl_4-4_hor",
                "fileUrl": "https://s3-eu-west-1.amazonaws.com/developers.gelato.com/product-examples/test_print_job_5R_4-4_hor_none.pdf",
                "quantity": 30
            }
        ]
    }'

Response example

{
    "id": "37365096-6628-4538-a9c2-fbf9892deb85",
    "orderReferenceId": "{{myOrderId}}",
    "customerReferenceId": "{{myCustomerId}}",
    "fulfillmentStatus": "printed",
    "financialStatus": "paid",
    "currency": "USD",
    "channel": "api",
    "createdAt": "2021-01-14T12:30:03+00:00",
    "updatedAt": "2021-01-14T12:32:03+00:00",
    "orderedAt": "2021-01-14T12:32:03+00:00",
    "items": [
        {
            "id": "0549170c-bd7d-4d43-b7a1-34c855e6aefb", 
            "itemReferenceId": "{{myItemId1}}",
            "productUid": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
            "fileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_original",   
            "processedFileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_processed",
            "quantity": 100,         
            "fulfillmentStatus": "printed",
            "previews": [
                {
                    "type": "preview_default",
                    "url": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/preview_default"
                }           
            ]         
        },
        {
            "id": "13c165fe-de51-4ea9-86e6-98503ae14486", 
            "itemReferenceId": "{{myItemId2}}",
            "productUid": "cards_pf_5r_pt_100-lb-cover-coated-silk_cl_4-4_hor",
            "fileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_original",   
            "processedFileUrl": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/file_processed",
            "quantity": 100,         
            "fulfillmentStatus": "printed",
            "previews": [
                {
                    "type": "preview_default",
                    "url": "https://gelato-api-live.s3.eu-west-1.amazonaws.com/order/order_product_file/preview_default"
                }           
            ]  
        }      
    ],    
    "shipment": {
        "id": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
        "shipmentMethodName": "UPS Surepost",
        "shipmentMethodUid": "ups_surepost",
        "minDeliveryDays": 6,
        "maxDeliveryDays": 7,
        "minDeliveryDate": "2019-08-29",
        "maxDeliveryDate": "2019-08-30",
        "totalWeight": 613,
        "fulfillmentCountry": "US",
        "packagesCount": 1,
        "packages": [
            {
                "id": "4a771ca0-7de4-4f0b-a7d4-9c952093af6c",
                "orderItemIds": [
                    "0549170c-bd7d-4d43-b7a1-34c855e6aefb",
                    "13c165fe-de51-4ea9-86e6-98503ae14486"
                ],
                "trackingCode": "12345678990",
                "trackingUrl": "http://test.tracking.url"
            }
        ]   
    },  
    "billingEntity": {
        "id": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
        "companyName": "Example",
        "companyNumber": "Example Number",
        "companyVatNumber": "Example VAT1234567890",
        "country": "US",
        "recipientName": "Paul Smith",
        "addressLine1": "451 Clarkson Ave",
        "addressLine2": "Brooklyn",
        "city": "New York",
        "postCode": "11203",
        "state": "NY",
        "email": "apisupport@gelato.com",
        "phone": "123456789"
    },    
    "shippingAddress": {
        "id": "d6bcf17f-3a48-4ec8-888e-70766ae8b56a",
        "orderId": "37365096-6628-4538-a9c2-fbf9892deb85",
        "country": "US",
        "firstName": "Paul",
        "lastName": "Smith",
        "companyName": "Example",
        "addressLine1": "451 Clarkson Ave",
        "addressLine2": "Brooklyn",
        "city": "New York",
        "postCode": "11203",
        "state": "NY",
        "email": "apisupport@gelato.com",
        "phone": "123456789"
    },
    "receipts": [
        {
            "id": "c74447e5-c543-4baf-8239-3620422b8d81",
            "orderId": "37365096-6628-4538-a9c2-fbf9892deb85",
            "transactionType": "purchase",
            "currency": "USD",
            "items": [
                {
                    "id": "b65bb8f3-c2a3-425e-a366-7e19c32c93e2",
                    "receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
                    "referenceId": "0549170c-bd7d-4d43-b7a1-34c855e6aefb",
                    "type": "product",
                    "title": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
                    "currency": "USD",
                    "priceBase": 12.47,
                    "amount": 1,
                    "priceInitial": 12.47,
                    "discount": 0,
                    "price": 12.47,
                    "vat": 0.75,
                    "priceInclVat": 13.22,
                    "createdAt": "2021-01-14T12:30:03+00:00",
                    "updatedAt": "2021-01-14T12:32:03+00:00"
                },
                {
                    "id": "3126e362-8369-4900-bcd3-6990d373b69c",
                    "receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
                    "referenceId": "13c165fe-de51-4ea9-86e6-98503ae14486",
                    "type": "product",
                    "title": "cards_pf_bx_pt_110-lb-cover-uncoated_cl_4-4_hor",
                    "currency": "USD",
                    "priceBase": 12.47,
                    "amount": 1,
                    "priceInitial": 12.47,
                    "discount": 0,
                    "price": 12.47,
                    "vat": 0.75,
                    "priceInclVat": 13.22,
                    "createdAt": "2021-01-14T12:30:03+00:00",
                    "updatedAt": "2021-01-14T12:32:03+00:00"
                },
                {
                    "id": "762f3563-ff24-4d4e-b6c7-fee19bfc878b",
                    "receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
                    "referenceId": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
                    "type": "shipment",
                    "title": "Delivery using SmartPost",
                    "currency": "USD",
                    "priceBase": 4.91,
                    "amount": 1,
                    "priceInitial": 4.91,
                    "discount": 0,
                    "price": 4.91,
                    "vat": 0.3,
                    "priceInclVat": 5.21,
                    "createdAt": "2021-01-14T12:30:03+00:00",
                    "updatedAt": "2021-01-14T12:32:03+00:00"
                },
                {
                    "id": "bb4c9eee-91a0-44a1-8ee0-a3cef29820f1",
                    "receiptId": "c74447e5-c543-4baf-8239-3620422b8d81",
                    "referenceId": "87cb3d74-de74-4bce-a682-e92f2652a4a2",
                    "type": "packaging",
                    "title": "Packaging",
                    "currency": "USD",
                    "priceBase": 1.7,
                    "amount": 1,
                    "priceInitial": 1.7,
                    "discount": 0,
                    "price": 1.7,
                    "vat": 0.1,
                    "priceInclVat": 1.8,
                    "createdAt": "2021-01-14T12:30:03+00:00",
                    "updatedAt": "2021-01-14T12:32:03+00:00"
                }              
            ],
            "productsPriceInitial": 24.94,
            "productsPriceDiscount": 0,
            "productsPrice": 24.94,
            "productsPriceVat": 1.5,
            "productsPriceInclVat": 26.44,
            "packagingPriceInitial": 1.7,
            "packagingPriceDiscount": 0,
            "packagingPrice": 1.7,
            "packagingPriceVat": 0.1,
            "packagingPriceInclVat": 1.8,
            "shippingPriceInitial": 4.91,
            "shippingPriceDiscount": 0,
            "shippingPrice": 4.91,
            "shippingPriceVat": 0.3,
            "shippingPriceInclVat": 5.21,
            "discount": 0,
            "discountVat": 0,
            "discountInclVat": 0,
            "totalInitial": 31.55,
            "total": 31.55,
            "totalVat": 1.9,
            "totalInclVat": 33.45
          }
    ]
}

Request

Parameter Type Description
orderReferenceId (required) string Reference to your internal order id.
customerReferenceId (required) string Reference to your internal customer id.
currency (required) string Currency iso code in ISO 4217 standard. Currency that the order should be charged in.
Supported currencies: EUR, USD, JPY, BGN, CZK, DKK, GBP, HUF, PLN, RON, SEK, CHF, ISK, NOK, HRK, RUB, TRY, AUD, BRL, CAD, CNY, HKD, IDR, ILS, INR, KRW, MXN, MYR, NZD, PHP, SGD, THB, ZAR, CLP, AED
Note: It is applicable only for customers using wallets or credit cards for payments.
shippingAddress (required) ShippingAddressObject Shipping address information.
items (required) ItemObject[] A list of line item objects, each containing information about an item in the order.
** shipmentMethodUid** (optional) string The shipping method identifier. You can specify which shipment method should be used during place order. By default we will use cheapest shipping method for delivery the order. Or you can send here type of shipment method - normal or express.

ItemObject

Parameter Type Description
itemReferenceId (required) string Reference to your internal order item id. Must be unique within your order.
productUid (required) string Type of printing product in product uid format.
pageCount (optional) integer The page count for multipage products. This parameter is only needed for multi-page products. All pages in the product, including front and back cover are included in the count. For example for a Wire-o Notebook there are 112 inner pages (56 leaves), 2 front (outer and inside) and 2 back cover (outer and inside) pages, total 116 pages. The pageCount is 116. Read more
fileUrl (optional) string Url to the product file. Url is required for printable products only. Supported file formats are: PDF, PNG and JPEG. For PDF files please use one of the compatible PDF/X standards, for example in PDF/X-1a:2003 or PDF/X-4 standard.
quantity (required) integer The product quantity. Defines how many copies of product should be printed. The minimum value is 1

ShippingAddressObject

Please note that addresses for China (CN), Japan (JP), South Korea (KR) and Russia (RU) must be entered in local language due to shipping providers' requirements. Please see detailed requirements by field below

Parameter Type Description
country (required) string The two-character ISO 3166-1 code that identifies the country or region. Please note: the country code for United Kingdom is GB and not UK as used in the top-level domain names for that country.
Pattern: ^[A-Z]{2}$
firstName (required) string The first name of the recipient at this address.
Maximum length is 25 characters. It can be any symbol or character.
lastName (required) string The last name of the recipient at this address.
Maximum length is 25 characters. It can be any symbol or character.
companyName (optional) string The company name of the recipient at this address.
Maximum length is 60 characters. It can be any symbol or character.
addressLine1 (required) string The first line of the address. For example, number, street, and so on.
Maximum length is 35 characters. It must be in local language for Russia (RU), China (CN), Japan (JP) and South Korea (KR) and up to 10 Latin characters are allowed.
addressLine2 (optional) string The second line of the address. For example, suite or apartment number.
Maximum length is 35 characters. It must be in local language for Russia (RU), China (CN), Japan (JP) and South Korea (KR) and up to 10 Latin characters are allowed.
city (required) string The city name.
Maximum length is 30 characters. It must be in local language for Russia (RU), China (CN), Japan (JP) and South Korea (KR).
postCode (required) string The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
Maximum length is 15 characters
state (optional) string The code for a US state or the equivalent for other countries. Required for requests if the address is in one of these countries: Australia, Canada or United States.
Maximum length is 35 characters. See list of state codes
email (required) string The email address for the recipient.
Pattern: .+@["-].+$
phone (optional) string The phone number, in E.123 format.
Maximum length is 25 characters
isBusiness (optional) bool Boolean value, declares the recipient being a business. Use if tax for recipient country is different for private and business customers (e.g. in Brazil) to change federalTaxId field type. Mandatory for Brazil if recipient is a company.
federalTaxId (optional) string The Federal Tax identification number of recipient. Use to provide CPF/CNPJ of a Brazilian recipient. Mandatory for Brazil. In order to supply CNPJ instead of CPF, set isBusiness field to true.
stateTaxId (optional) string The State Tax identification number of recipient. Use to provide IE of a Brazilian recipient. Mandatory for Brazil if recipient is a company. In order to supply this field, set isBusiness field to true.
registrationStateCode (optional) string The code number for a US state or the equivalent for other countries that defines state where recipient company is registered. Mandatory for Brazil if recipient is a company. In order to supply this field, set isBusiness field to true.

Response

Response has the same structure as on Order Get API