Glue API: Retrieve shipments in orders

Last updated:
Edit on GitHub

This document describes how to retrieve shipments in orders. For full information about the endpoint, see Retrieve orders

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see:

Retrieve an order

To retrieve detailed information about an order, send the following request:

GET /orders/{{order_id}}

PATH PARAMETER DESCRIPTON
{{order_id}} The unique identifier of an order. Retrieve all orders to get it.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ An alphanumeric string that authorizes the customer to send requests to protected resources. Get it by authenticating as a customer.
STRING PARAMETER DESCRIPTION POSSIBLE VALUES
include Adds resource relationships to the request. order-shipments
REQUEST USAGE
GET https://glue.mysprykershop.com/orders/DE--6?include=order-shipments Retrieves information about the order with the id DE--6, with order shipments included.

Response

Response sample: retrieve an order with order shipments included 
{
    "data": {
        "type": "orders",
        "id": "DE--6",
        "attributes": {
            "merchantReferences": [],
            "itemStates": [
                "payment pending"
            ],
            "createdAt": "2021-01-05 13:43:23.000000",
            "currencyIsoCode": "EUR",
            "priceMode": "GROSS_MODE",
            "totals": {
                "expenseTotal": 1180,
                "discountTotal": 0,
                "taxTotal": 12173,
                "subtotal": 75064,
                "grandTotal": 76244,
                "canceledTotal": 0,
                "remunerationTotal": 0
            },
            "billingAddress": {
                "salutation": "Mr",
                "firstName": "Spencor",
                "middleName": null,
                "lastName": "Hopkin",
                "address1": "Julie-Wolfthorn-Strasse",
                "address2": "1",
                "address3": "new address",
                "company": "spryker",
                "city": "Berlin",
                "zipCode": "10115",
                "poBox": null,
                "phone": "+49 (30) 2084 98350",
                "cellPhone": null,
                "description": null,
                "comment": null,
                "email": null,
                "country": "Germany",
                "iso2Code": "DE"
            },
            "shippingAddress": null,
            "items": [
                {
                    "merchantReference": null,
                    "state": "payment pending",
                    "name": "Samsung Galaxy S5 mini",
                    "sku": "066_23294028",
                    "sumPrice": 39353,
                    "quantity": 1,
                    "unitGrossPrice": 39353,
                    "sumGrossPrice": 39353,
                    "taxRate": "19.00",
                    "unitNetPrice": 0,
                    "sumNetPrice": 0,
                    "unitPrice": 39353,
                    "unitTaxAmountFullAggregation": 6283,
                    "sumTaxAmountFullAggregation": 6283,
                    "refundableAmount": 39353,
                    "canceledAmount": 0,
                    "sumSubtotalAggregation": 39353,
                    "unitSubtotalAggregation": 39353,
                    "unitProductOptionPriceAggregation": 0,
                    "sumProductOptionPriceAggregation": 0,
                    "unitExpensePriceAggregation": 0,
                    "sumExpensePriceAggregation": null,
                    "unitDiscountAmountAggregation": 0,
                    "sumDiscountAmountAggregation": 0,
                    "unitDiscountAmountFullAggregation": 0,
                    "sumDiscountAmountFullAggregation": 0,
                    "unitPriceToPayAggregation": 39353,
                    "sumPriceToPayAggregation": 39353,
                    "taxRateAverageAggregation": "19.00",
                    "taxAmountAfterCancellation": null,
                    "orderReference": null,
                    "uuid": "3db99597-99a0-58a9-a0ea-696e8da0026e",
                    "isReturnable": false,
                    "idShipment": 11,
                    "bundleItemIdentifier": null,
                    "relatedBundleItemIdentifier": null,
                    "salesOrderConfiguredBundle": null,
                    "salesOrderConfiguredBundleItem": null,
                    "metadata": {
                        "superAttributes": {
                            "color": "Blue"
                        },
                        "image": "https://images.icecat.biz/img/gallery_mediums/23294028_3275.jpg"
                    },
                    "salesUnit": null,
                    "calculatedDiscounts": [],
                    "productOptions": [],
                    "amount": null
                },
                {
                    "merchantReference": null,
                    "state": "payment pending",
                    "name": "Sony Xperia Z3 Compact",
                    "sku": "076_24394207",
                    "sumPrice": 35711,
                    "quantity": 1,
                    "unitGrossPrice": 35711,
                    "sumGrossPrice": 35711,
                    "taxRate": "19.00",
                    "unitNetPrice": 0,
                    "sumNetPrice": 0,
                    "unitPrice": 35711,
                    "unitTaxAmountFullAggregation": 5702,
                    "sumTaxAmountFullAggregation": 5702,
                    "refundableAmount": 35711,
                    "canceledAmount": 0,
                    "sumSubtotalAggregation": 35711,
                    "unitSubtotalAggregation": 35711,
                    "unitProductOptionPriceAggregation": 0,
                    "sumProductOptionPriceAggregation": 0,
                    "unitExpensePriceAggregation": 0,
                    "sumExpensePriceAggregation": null,
                    "unitDiscountAmountAggregation": 0,
                    "sumDiscountAmountAggregation": 0,
                    "unitDiscountAmountFullAggregation": 0,
                    "sumDiscountAmountFullAggregation": 0,
                    "unitPriceToPayAggregation": 35711,
                    "sumPriceToPayAggregation": 35711,
                    "taxRateAverageAggregation": "19.00",
                    "taxAmountAfterCancellation": null,
                    "orderReference": null,
                    "uuid": "40274175-4398-5927-8980-48ead5053e69",
                    "isReturnable": false,
                    "idShipment": 12,
                    "bundleItemIdentifier": null,
                    "relatedBundleItemIdentifier": null,
                    "salesOrderConfiguredBundle": null,
                    "salesOrderConfiguredBundleItem": null,
                    "metadata": {
                        "superAttributes": {
                            "color": "White"
                        },
                        "image": "https://images.icecat.biz/img/norm/medium/24394207-3552.jpg"
                    },
                    "salesUnit": null,
                    "calculatedDiscounts": [],
                    "productOptions": [],
                    "amount": null
                }
            ],
            "expenses": [
                {
                    "type": "SHIPMENT_EXPENSE_TYPE",
                    "name": "Express",
                    "sumPrice": 590,
                    "unitGrossPrice": 590,
                    "sumGrossPrice": 590,
                    "taxRate": "19.00",
                    "unitNetPrice": 0,
                    "sumNetPrice": 0,
                    "canceledAmount": null,
                    "unitDiscountAmountAggregation": null,
                    "sumDiscountAmountAggregation": null,
                    "unitTaxAmount": 94,
                    "sumTaxAmount": 94,
                    "unitPriceToPayAggregation": 590,
                    "sumPriceToPayAggregation": 590,
                    "taxAmountAfterCancellation": null,
                    "idShipment": 11,
                    "idSalesExpense": 11
                },
                {
                    "type": "SHIPMENT_EXPENSE_TYPE",
                    "name": "Express",
                    "sumPrice": 590,
                    "unitGrossPrice": 590,
                    "sumGrossPrice": 590,
                    "taxRate": "19.00",
                    "unitNetPrice": 0,
                    "sumNetPrice": 0,
                    "canceledAmount": null,
                    "unitDiscountAmountAggregation": null,
                    "sumDiscountAmountAggregation": null,
                    "unitTaxAmount": 94,
                    "sumTaxAmount": 94,
                    "unitPriceToPayAggregation": 590,
                    "sumPriceToPayAggregation": 590,
                    "taxAmountAfterCancellation": null,
                    "idShipment": 12,
                    "idSalesExpense": 12
                }
            ],
            "payments": [
                {
                    "amount": 76244,
                    "paymentProvider": "DummyPayment",
                    "paymentMethod": "Invoice"
                }
            ],
            "shipments": [],
            "calculatedDiscounts": [],
            "bundleItems": []
        },
        "links": {
            "self": "https://glue.mysprykershop.com/orders/DE--6?include=order-shipments"
        },
        "relationships": {
            "order-shipments": {
                "data": [
                    {
                        "type": "order-shipments",
                        "id": "11"
                    },
                    {
                        "type": "order-shipments",
                        "id": "12"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "order-shipments",
            "id": "11",
            "attributes": {
                "itemUuids": [
                    "3db99597-99a0-58a9-a0ea-696e8da0026e"
                ],
                "methodName": "Express",
                "carrierName": "Spryker Dummy Shipment",
                "requestedDeliveryDate": null,
                "shippingAddress": {
                    "salutation": "Mrs",
                    "firstName": "Sonia",
                    "middleName": null,
                    "lastName": "Wagner",
                    "address1": "Julie-Wolfthorn-Strasse",
                    "address2": "25",
                    "address3": "new one",
                    "company": "spryker",
                    "city": "Berlin",
                    "zipCode": "10115",
                    "poBox": null,
                    "phone": "+49 (30) 2084 98350",
                    "cellPhone": null,
                    "description": null,
                    "comment": null,
                    "email": null,
                    "country": "Germany",
                    "iso2Code": "DE"
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/order-shipments/11"
            }
        },
        {
            "type": "order-shipments",
            "id": "12",
            "attributes": {
                "itemUuids": [
                    "40274175-4398-5927-8980-48ead5053e69"
                ],
                "methodName": "Express",
                "carrierName": "Spryker Dummy Shipment",
                "requestedDeliveryDate": "2021-09-29",
                "shippingAddress": {
                    "salutation": "Mr",
                    "firstName": "Spencor",
                    "middleName": null,
                    "lastName": "Hopkin",
                    "address1": "Julie-Wolfthorn-Strasse",
                    "address2": "1",
                    "address3": "new one",
                    "company": "spryker",
                    "city": "Berlin",
                    "zipCode": "10115",
                    "poBox": null,
                    "phone": "+49 (30) 2084 98350",
                    "cellPhone": null,
                    "description": null,
                    "comment": null,
                    "email": null,
                    "country": "Germany",
                    "iso2Code": "DE"
                }
            },
            "links": {
                "self": "https://glue.mysprykershop.com/order-shipments/12"
            }
        }
    ]
}

General order information

RESOURCE ATTRIBUTE TYPE DESCRIPTION
itemStates Array Statuses of the order’s items in the state machine.
createdAt String Date and time when the order was created.
currencyIsoCode String ISO 4217 code of the currency that was selected when placing the order.
priceMode String Price mode that was active when placing the order. Possible values:
  • NET_MODE—prices before tax.
  • GROSS_MODE—prices after tax.

Totals calculations

RESOURCE Attribute Type Description
totals Object Totals calculations.
totals.expenseTotal Integer Total amount of expenses (e.g. shipping costs).
totals.discountTotal Integer Total amount of discounts applied.
totals.taxTotal Integer Total amount of taxes paid.
totals.subtotal Integer Subtotal of the order.
totals.grandTotal Integer Grand total of the order
totals.canceledTotal Integer Total canceled amount.
totals.remunerationTotal Integer Total sum of remuneration.

Billing and shipping addresses

RESOURCE Attribute Type Description
billingAddress object List of attributes describing the billing address of the order.
billingAddress.salutation String Salutation to use when addressing the customer.
billingAddress.firstName String Customer’s first name.
billingAddress.middleName String Customer’s middle name.
billingAddress.lastName String Customer’s last name.
billingAddress.address1 String 1st line of the customer’s address.
billingAddress.address2 String 2nd line of the customer’s address.
billingAddress.address3 String 3rd line of the customer’s address.
billingAddress.company String Specifies the customer’s company.
billingAddress.city String Specifies the city.
billingAddress.zipCode String ZIP code.
billingAddress.poBox String PO Box to use for communication.
billingAddress.phone String Specifies the customer’s phone number.
billingAddress.cellPhone String Mobile phone number.
billingAddress.description String Address description.
billingAddress.comment String Address comment.
billingAddress.email String Email address to use for communication.
billingAddress.country String Specifies the country.
billingAddress.iso2Code String ISO 2-Letter Country Code to use.
shippingAddress object Shipment address of the order. This value is returned only if you submit an order without split delivery. See Checking out purchases in version 202009.0 to learn how to do that.

Order item information

RESOURCE ATTRIBUTE TYPE DESCRIPTION
items array Items in the order.
items.state String Defines the state of the order in the state machine.
bundleItems Array Array of objects describing the concrete product bundles in the order.
bundleItems.bundleItemIdentifier Integer Defines the relation between the bundle and its items. The items of the bundle have the same value in the relatedBundleItemIdentifier attribute.
items.relatedBundleItemIdentifier Integer Defines the relation between the item and its bundle. The bundle to which this the item belongs has the same value in the bundleItemIdentifier attribute.
items.name String Product name.
items.sku String Product SKU.
items.sumPrice Integer Sum of all product prices.
items.quantity Integer Product quantity ordered.
items.unitGrossPrice Integer Single item gross price.
items.sumGrossPrice Integer Sum of items gross price.
items.taxRate Integer Current tax rate, in percent.
items.unitNetPrice Integer Single item net price.
items.sumNetPrice Integer Sum total of net prices for all items.
items.unitPrice Integer Single item price without assuming if it is new or gross. This price should be displayed everywhere when a product price is displayed. It allows switching tax mode without side effects.
items.unitTaxAmountFullAggregation Integer Total tax amount for a given item, with additions.
items.sumTaxAmountFullAggregation Integer Total tax amount for a given sum of items, with additions.
items.refundableAmount Integer Available refundable amount for an item (order only).
items.canceledAmount Integer Total canceled amount for this item (order only).
items.sumSubtotalAggregation Integer Sum of subtotals of the items.
items.unitSubtotalAggregation Integer Subtotal for the given item.
items.unitProductOptionPriceAggregation Integer Item total product option price.
items.sumProductOptionPriceAggregation Integer Item total of product options for the given sum of items.
items.unitExpensePriceAggregation Integer Item expense total for a given item.
items.sumExpensePriceAggregation Integer Total amount of expenses for the given items.
items.unitDiscountAmountAggregation Integer Item total discount amount.
items.sumDiscountAmountAggregation Integer Sum of Item total discount amounts.
items.unitDiscountAmountFullAggregation Integer Sum of item total discount amount.
items.sumDiscountAmountFullAggregation Integer Item total discount amount, with additions.
items.unitPriceToPayAggregation Integer Item total price to pay after discounts, with additions.
items.sumPriceToPayAggregation Integer Sum of all prices to pay (after discounts were applied).
items.taxRateAverageAggregation Integer Item tax rate average, with additions. This value is used when recalculating the tax amount after cancellation.
items.taxAmountAfterCancellation Integer Tax amount after cancellation, recalculated using tax average.
items.uuid String Unique identifier of the item in the order.
items.isReturnable Boolean Defines if the customer can return the item.
items.idShipment Integer Unique identifier of the shipment to which the item belongs. To retrieve all the shipments of the order, include the order-shipments resource into the request.
items.bundleItemIdentifier Integer Defines the relation between the bundle and its items. The items of the bundle have the same value in the relatedBundleItemIdentifier attribute.
items.relatedBundleItemIdentifier Integer Defines the relation between the item and its bundle. The bundle to which this the item belongs has the same value in the bundleItemIdentifier attribute.
items.salesOrderConfiguredBundle Object Contains information about the purhased configurable bundle.
items.idSalesOrderConfiguredBundle Integer Unique identifier of the purchased configured bundle.
items.idSalesOrderConfiguredBundle.configurableBundleTemplateUuid String Unique identifier of the configurable bundle template in the system.
items.idSalesOrderConfiguredBundle.name String Name of the configured bundle.
items.idSalesOrderConfiguredBundle.quantity Integer Quantity of the ordered configurable bundles.
items.salesOrderConfiguredBundleItem Object Contains information about the items of the configured bundle.
items.salesOrderConfiguredBundleItem.configurableBundleTemplateSlotUuid String Unique identifier of the configurable bundle slot in the system.
items.metadata object Metadata of the concrete product.
items.metadata.superAttributes String Attributes of the order item.
items.metadata.image String Product image URL.

Measurement unit calculations

| RESOURCE | ATTRIBUTE | TYPE | DESCRIPTION | | — | — | — | | salesUnit | Object | List of attributes defining the sales unit to be used for item amount calculation. | | conversion | integer | Factor to convert a value from sales to base unit. If it is “null”, the information is taken from the global conversions. | | precision | integer | Ratio between a sales unit and a base unit. | | measurementUnit | string | Code of the measurement unit. | | name | String | Name of the measurement unit. | | code | String | Code of the measurement unit. |

Calculated discounts for items

RESOURCE ATTRIBUTE TYPE DESCRIPTION
items.calculatedDiscounts Array List of attributes describing the discount calculated for this item.
items.calculatedDiscounts.unitAmount Integer Discount value applied to this order item.
items.calculatedDiscounts.sumAmount Integer Sum of the discount values applied to this order item.
items.calculatedDiscounts.displayName String Name of the discount applied.
items.calculatedDiscounts.description String Description of the discount.
items.calculatedDiscounts.voucherCode String Voucher code redeemed.
items.calculatedDiscounts.quantity String Number of discounts applied to the product.

Product options

RESOURCE ATTRIBUTE TYPE DESCRIPTION
items.productOptions Array List of product options ordered with this item.
items.productOptions.optionGroupName String Name of the group to which the product option belongs.
items.productOptions.sku String SKU of the product option.
items.productOptions.optionName String Name of the product option.
items.productOptions.price Integer Price of the product option.

Calculated discounts

RESOURCE ATTRIBUTE TYPE DESCRIPTION
calculatedDiscounts Array Discounts applied to this order item.
calculatedDiscounts.unitAmount Integer Amount of the discount provided by the given item for each unit of the product, in cents.
calculatedDiscounts.sumAmount Integer Total amount of the discount provided by the given item, in cents.
calculatedDiscounts.displayName String Display name of the given discount.
calculatedDiscounts.description String Description of the given discount.
calculatedDiscounts.voucherCode String Voucher code applied, if any.
calculatedDiscounts.quantity String Number of times the discount was applied.

Expenses

RESOURCE ATTRIBUTE TYPE DESCRIPTION
expenses array Additional expenses of the order.
expenses.type String Expense type.
expenses.name String Expense name.
expenses.sumPrice Integer Sum of expenses calculated.
expenses.unitGrossPrice Integer Single item’s gross price.
expenses.sumGrossPrice Integer Sum of items’ gross price.
expenses.taxRate Integer Current tax rate in percent.
expenses.unitNetPrice Integer Single item net price.
expenses.sumNetPrice Integer Sum of items’ net price.
expenses.canceledAmount Integer Total canceled amount for this item (order only).
expenses.unitDiscountAmountAggregationexpenses. Integer Item total discount amount.
expenses.sumDiscountAmountAggregation Integer Sum of items’ total discount amount.
expenses.unitTaxAmount Integer Tax amount for a single item, after discounts.
expenses.sumTaxAmount Integer Tax amount for a sum of items (order only).
expenses.unitPriceToPayAggregation Integer Item total price to pay after discounts with additions.
expenses.sumPriceToPayAggregation Integer Sum of items’ total price to pay after discounts with additions.
expenses.taxAmountAfterCancellation Integer Tax amount after cancellation, recalculated using tax average.
expenses.idShipment Integer Unique identifier of the shipment to which this expense belongs. To retrieve all the shipments of the order, include the order-shipments resource in the request.
expenses.idSalesExpense Integer Unique identifier of the expense.

Payments

RESOURCE ATTRIBUTE TYPE DESCRIPTION
payments Array A list of payments used in this order.
amount Integer Amount paid via the corresponding payment provider in cents.
paymentProvider String Name of the payment provider.
paymentMethod String Name of the payment method.

Shipments

RESOURCE ATTRIBUTE TYPE DESCRIPTION
shipments object Information about the shipments used in this order. This value is returned only if you submit an order without split delivery. To learn how to do that, see Check out purchases. To see all the attributes that are returned when retrieving orders without split delivery, see Retrieving orders. To retrieve shipment details, include the order-shipments resource in the request.
RESOURCE ATTRIBUTE TYPE DESCRIPTION
order-shipments itemUuids String
order-shipments methodName String
order-shipments carrierName String
order-shipments requestedDeliveryDate Date
order-shipments shippingAddress Object
order-shipments shippingAddress.salutation String
order-shipments shippingAddress.firstName String
order-shipments shippingAddress.middleName String Customer’s middle name.
order-shipments shippingAddress.lastName String Customer’s last name.
order-shipments shippingAddress.address1 String The 1st line of the customer’s address.
order-shipments shippingAddress.address2 String The 2nd line of the customer’s address.
order-shipments shippingAddress.address3 String The 3rd line of the customer’s address.
order-shipments shippingAddress.company String Specifies the customer’s company.
order-shipments shippingAddress.city String Specifies the city.
order-shipments shippingAddress.zipCode String ZIP code.
order-shipments shippingAddress.poBox String PO Box to use for communication.
order-shipments shippingAddress.phone String Specifies the customer’s phone number.
order-shipments shippingAddress.cellPhone String Mobile phone number.
order-shipments shippingAddress.description String Address description.
order-shipments shippingAddress.comment String Address comment.
order-shipments shippingAddress.email String Email address to use for communication.
order-shipments shippingAddress.country String Specifies the country.
order-shipments shippingAddress.iso2Code String ISO 2-Letter Country Code to use.

Possible errors

CODE REASON
001 Access token is invalid.
002 Access token is missing.
801 Order with the given order reference is not found.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.