Basic information

GET /{shopId}/carts

Returns a list of carts.

Authorisation

OAuth 2.0 Token required with scopes:

carts_read

URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop

Query parameters

Name Type Description
locale string

Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop.

Required: false
Example: en_US
page integer

Represents the current page.

Required: false
Default: 1
Minimum: 1
resultsPerPage integer

Specifies the maximum number of results per page.

Required: false
Default: 10
Maximum: 100
createdBefore string

Filters carts created before this timestamp (format according to ISO 8601). The maximum time frame for displaying carts is 30 days. If no filter is set, all carts will be displayed.

Required: false
createdAfter string

Filters carts created after this timestamp (format according to ISO 8601). The maximum time frame for displaying carts is 30 days. If no filter is set, all carts will be displayed.

Required: false
hasAddressData boolean

Returns carts that hold address data. If set to false, only the carts without address will be returned. If parameter is not set, all carts will be returned.

Required: false

Response attributes

Name Type Description
results

integer

The number of carts in total.

page

integer

The page number on which the cart appears.

resultsPerPage

integer

The number of carts returned per page.

items

array of cart

The list of all carts.

Response

HTTP 200

Media type application/json

{
  "results": 1,
  "page": 1,
  "resultsPerPage": 10,
  "items": [
    {
      "cartId": "5858EDDD-18DF-8D31-502D-D5809AB37DF1",
      "billingAddress": null,
      "shippingAddress": null,
      "lineItemContainer": {
        "grandTotal": {
          "taxType": "GROSS",
          "formatted": "11.68 €",
          "amount": 11.68,
          "currency": "EUR"
        },
        "totalBeforeTax": {
          "taxType": "NET",
          "formatted": "9.82 €",
          "amount": 9.82,
          "currency": "EUR"
        },
        "totalTax": {
          "taxType": "NONE",
          "formatted": "1.86 €",
          "amount": 1.86,
          "currency": "EUR"
        },
        "lineItemsSubTotal": {
          "taxType": "GROSS",
          "formatted": "12.99 €",
          "amount": 12.99,
          "currency": "EUR"
        },
        "productLineItems": [
          {
            "lineItemId": "5858EDE0-6E6D-DBC6-A97B-D5809AB37DD9",
            "sku": "Acc-001",
            "name": "Connector 6.3 mm",
            "productId": "54E72E1F-746A-8B6E-8E41-0A0C05E64669",
            "quantity": {
              "amount": 1,
              "unit": "yd³"
            },
            "lineItemPrice": {
              "taxType": "GROSS",
              "formatted": "12.99 €",
              "amount": 12.99,
              "currency": "EUR"
            },
            "singleItemPrice": {
              "taxType": "GROSS",
              "formatted": "12.99 €",
              "amount": 12.99,
              "currency": "EUR"
            },
            "lineItemCouponDiscount": {
                        "taxType": "GROSS",
                        "formatted": "1.70 €",
                        "amount": 1.7,
                        "currency": "EUR"
            },
            "images": [
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_h.jpg",
                "classifier": "HotDeal",
                "isZoomEnabled": false
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6.jpg",
                "classifier": "Large",
                "isZoomEnabled": false
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_m.jpg",
                "classifier": "Medium",
                "isZoomEnabled": false
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_s.jpg",
                "classifier": "Small",
                "isZoomEnabled": false
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/54E7/2E1F/746A/8B6E/8E41/0A0C/05E6/4669/acc6_xs.jpg",
                "classifier": "Thumbnail",
                "isZoomEnabled": false
              }
            ],
            "links": [
              {
                "rel": "product",
                "href": "https://pm.epages.com/rs/shops/apidocu/products/54E72E1F-746A-8B6E-8E41-0A0C05E64669"
              },
              {
                "rel": "taxClass",
                "href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF"
              }
            ],
            "variationString": null,
            "essentialFeatures": null,
            "taxClass": {
              "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
              "name": "standard",
              "percentage": 19
            },
            "deliveryWeight": {
              "amount": 50,
              "unit": "oz"
            },
            "energyLabelsString": "C",
            "energyLabelsMaxEfficiencyString": "A+++",
            "energyLabelSourceFile": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/Products/be_40401/label-1-9dee85f24e1.png"
          }
        ],
        "couponLineItem": null,
        "shippingPrice": {
          "taxType": "GROSS",
          "formatted": "8.69 €",
          "amount": 8.69,
          "currency": "EUR"
        },
        "deposits": [],
        "ecoParticipations": [],
        "shippingOptions": [],
        "basketDiscount": {
          "name": "cart discount",
          "lineItemPrice": {
            "taxType": "GROSS",
            "formatted": "-10.00 €",
            "amount": -10,
            "currency": "EUR"
          },
          "links": []
        }
      },
      "shippingData": {
        "shippingMethod": {
          "id": "5171DD86-C077-0726-C448-AC14145F9026",
          "name": "Standard delivery"
        },
        "price": {
          "taxType": "GROSS",
          "formatted": "8.69 €",
          "amount": 8.69,
          "currency": "EUR"
        },
        "taxes": [
          {
            "taxClass": {
              "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
              "name": "standard",
              "percentage": 19
            },
            "price": {
              "taxType": "NONE",
              "formatted": "1.39 €",
              "amount": 1.39,
              "currency": "EUR"
            }
          }
        ]
      },
      "paymentData": {
        "paymentMethod": {
          "id": "5171DD89-6DE5-E758-E046-AC14145F9009",
          "name": "PayPal",
          "providerName": "PayPal"
        },
        "transactionId": "7PM024488F971832G",
        "price": {
          "taxType": "GROSS",
          "formatted": "0.00 €",
          "amount": 0,
          "currency": "EUR"
        },
        "status": null,
        "taxes": null
      },
      "minimumCart": {
        "status": true,
        "code": "SumDiscount",
        "amount": null
      },
      "pickupToken": "NDU0NjIzY2FkYjg3OTNmOGQyOGYyZjg0NTliYTgwNDFjMzBjODYzYjcyN2Y2ZDZmMmVlYWMwYjFiYWU0NjRkZV8xNDgyMjIzOTAz",
      "creationDate": "2018-12-17T21:07:29Z",
      "checkoutUrl": "https://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/AnonymousUsers/1/Baskets/46072&ChangeAction=PickupBasket&PickupToken=NDU0NjIzY2FkYjg3OTNmOGQyOGYyZjg0NTliYTgwNDFjMzBjODYzYjcyN2Y2ZDZmMmVlYWMwYjFiYWU0NjRkZV8xNDgyMjIzOTAz",
      "registerSessionUrl": "https://pm.epages.com/epages/apidocu.sf/?ObjectPath=/Shops/apidocu/AnonymousUsers/2/Baskets/46072&ChangeAction=PickupBasket&PickupToken=NTRjZWJmNjdhNzNlYTUzNDAxZTgyZTc4ODYwYTliMDUxMDIzNDQ2OWY2NWQ5NWRmN2Q2YmVjZjVjNzljOTQ2N18xNDgyMjI3OTE3",
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/carts/5858EDDD-18DF-8D31-502D-D5809AB37DF1"
        },
        {
          "rel": "shipping-method",
          "href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026"
        },
        {
          "rel": "add-coupon",
          "href": "https://pm.epages.com/rs/shops/apidocu/carts/5858EDDD-18DF-8D31-502D-D5809AB37DF1/coupon"
        }
      ]
    }
  ]
}