---
title: Searches for carts with paging.
slug: commerce-connect-15/service-api/EKRm-searches-for-carts-with-paging
docTags:
createdAt: 2026-10-09T17:33:29.599Z
---
{
"id": "uTY0srVPJgELml6I_X6qL",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "http://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount}",
"servers": [
{
"url": "http://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount}"
},
{
"url": "https://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount}"
}
],
"name": "Searches for carts with paging.",
"description": "If the Serializable carts feature is enabled, returns NotImplemented.
",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "start",
"type": "integer",
"description": "Start record index.",
"format": "int32"
},
{
"kind": "required",
"name": "maxCount",
"type": "integer",
"description": "Max number of records to return.",
"format": "int32"
}
],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [],
"cookieParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Return the carts.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "array",
"description": "Cart model.",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.CartModel[]",
"schema": [
{
"name": "AddressId",
"kind": "optional",
"type": "string",
"description": "Address ID."
},
{
"name": "AffiliateId",
"kind": "optional",
"type": "string",
"description": "Affiliate ID (GUID).
",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid"
},
{
"name": "BillingCurrency",
"kind": "optional",
"type": "string",
"description": "Billing currency."
},
{
"name": "CustomerId",
"kind": "optional",
"type": "string",
"description": "Customer ID (GUID).
",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid"
},
{
"name": "CustomerName",
"kind": "optional",
"type": "string",
"description": "Customer name."
},
{
"name": "HandlingTotal",
"kind": "optional",
"type": "number",
"description": "Handling total.",
"format": "double"
},
{
"name": "InstanceId",
"kind": "optional",
"type": "string",
"description": "Instance ID (GUID).
",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid"
},
{
"name": "MarketId",
"kind": "optional",
"type": "string",
"description": "Market ID."
},
{
"name": "Name",
"kind": "required",
"type": "string",
"description": "Order name."
},
{
"name": "OrderAddresses",
"kind": "optional",
"type": "array",
"description": "List of addresses.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.OrderAddressModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.OrderAddressModel[]",
"schema": [
{
"name": "OrderGroupAddressId",
"kind": "optional",
"type": "integer",
"description": "Gets the order group address id.",
"format": "int32"
},
{
"name": "Name",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name."
},
{
"name": "FirstName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the first name."
},
{
"name": "LastName",
"kind": "optional",
"type": "string",
"description": "Gets or sets last name."
},
{
"name": "Organization",
"kind": "optional",
"type": "string",
"description": "Gets or sets the organization."
},
{
"name": "Line1",
"kind": "optional",
"type": "string",
"description": "Gets or sets the line1."
},
{
"name": "Line2",
"kind": "optional",
"type": "string",
"description": "Gets or sets the line2."
},
{
"name": "City",
"kind": "optional",
"type": "string",
"description": "Gets or sets the city."
},
{
"name": "State",
"kind": "optional",
"type": "string",
"description": "Gets or sets the state."
},
{
"name": "CountryCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the country code."
},
{
"name": "CountryName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name of the country."
},
{
"name": "PostalCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the postal code."
},
{
"name": "RegionCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the region code."
},
{
"name": "RegionName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name of the region."
},
{
"name": "DaytimePhoneNumber",
"kind": "optional",
"type": "string",
"description": "Gets or sets the daytime phone number."
},
{
"name": "EveningPhoneNumber",
"kind": "optional",
"type": "string",
"description": "Gets or sets the evening phone number."
},
{
"name": "FaxNumber",
"kind": "optional",
"type": "string",
"description": "Gets or sets the fax number."
},
{
"name": "Email",
"kind": "optional",
"type": "string",
"description": "Gets or sets the email."
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Gets the list of key value pairs for dealing with custom properties.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
]
},
{
"name": "OrderForms",
"kind": "optional",
"type": "array",
"description": "List of order forms.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.OrderFormModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.OrderFormModel[]",
"schema": [
{
"name": "Shipments",
"kind": "optional",
"type": "array",
"description": "Gets or sets the shipments.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.ShipmentModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.ShipmentModel[]",
"schema": [
{
"name": "DiscountsModel",
"kind": "optional",
"type": "array",
"description": "Gets the discounts.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.DiscountModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.DiscountModel[]",
"schema": [
{
"name": "DiscountId",
"kind": "optional",
"type": "integer",
"description": "Gets or sets the discount id.",
"format": "int32"
},
{
"name": "DiscountAmount",
"kind": "optional",
"type": "number",
"description": "Gets or sets the discount amount. Either fixed money value or percentage.",
"format": "double"
},
{
"name": "DiscountCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the discount code. Also known as a coupon code."
},
{
"name": "DiscountName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name of the discount."
},
{
"name": "DisplayMessage",
"kind": "optional",
"type": "string",
"description": "Gets or sets the display message."
},
{
"name": "DiscountValue",
"kind": "optional",
"type": "number",
"description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.",
"format": "double"
}
]
},
{
"name": "ShipmentId",
"kind": "optional",
"type": "integer",
"description": "Gets the shipment id.",
"format": "int32"
},
{
"name": "ShippingMethodId",
"kind": "optional",
"type": "string",
"description": "Gets or sets the shipping method id.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid"
},
{
"name": "ShippingMethodName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name of the shipping method."
},
{
"name": "ShippingTax",
"kind": "optional",
"type": "number",
"description": "Gets or sets the shipment tax.",
"format": "double"
},
{
"name": "ShippingAddressId",
"kind": "optional",
"type": "string",
"description": "Gets or sets the shipping address name."
},
{
"name": "ShipmentTrackingNumber",
"kind": "optional",
"type": "string",
"description": "Gets or sets the shipment tracking number."
},
{
"name": "ShippingDiscountAmount",
"kind": "optional",
"type": "number",
"description": "Gets or sets the shipping discount amount.",
"format": "double"
},
{
"name": "ShippingSubTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the shipping sub total.",
"format": "double"
},
{
"name": "ShippingTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the total shipping cost, including shipping discounts (if any) and shipping tax.
",
"format": "double"
},
{
"name": "Status",
"kind": "optional",
"type": "string",
"description": "Gets or sets the status."
},
{
"name": "PrevStatus",
"kind": "optional",
"type": "string",
"description": "Gets or sets the previous status."
},
{
"name": "PickListId",
"kind": "optional",
"type": "integer",
"description": "Gets or sets the pick list id.",
"format": "int32"
},
{
"name": "SubTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the sub total.",
"format": "double"
},
{
"name": "WarehouseCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the warehouse code."
},
{
"name": "LineItems",
"kind": "optional",
"type": "array",
"description": "Gets or sets the collection of line items.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.LineItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.LineItemModel[]",
"schema": [
{
"name": "LineItemId",
"kind": "optional",
"type": "integer",
"description": "Gets the identity of the line item.",
"format": "int32"
},
{
"name": "Code",
"kind": "optional",
"type": "string",
"description": "Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content."
},
{
"name": "DisplayName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the display name."
},
{
"name": "PlacedPrice",
"kind": "optional",
"type": "number",
"description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.",
"format": "double"
},
{
"name": "ExtendedPrice",
"kind": "optional",
"type": "number",
"description": "Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.
",
"format": "double"
},
{
"name": "DiscountedPrice",
"kind": "optional",
"type": "number",
"description": "Gets the line item discounted price. Only calculates the price with the \"line item discount amount,\" that is, the discount for a specific item.
",
"format": "double"
},
{
"name": "Quantity",
"kind": "optional",
"type": "number",
"description": "Gets or sets the number of items this line item contains.",
"format": "double"
},
{
"name": "ReturnQuantity",
"kind": "optional",
"type": "number",
"description": "Gets or sets the returned in stock quantity.",
"format": "double"
},
{
"name": "InventoryTrackingStatus",
"kind": "optional",
"type": "integer",
"description": "Gets or sets the inventory tracking status on whether to check inventory.",
"format": "int32",
"enum": [
"0",
"1"
]
},
{
"name": "IsInventoryAllocated",
"kind": "optional",
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has allocated inventory for the {EPiServer.Commerce.Order.ILineItem.Quantity}.
"
},
{
"name": "IsGift",
"kind": "optional",
"type": "boolean",
"description": "Gets or sets a value indicating whether the line item is a gift item."
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Gets the list of key value pairs for dealing with custom properties.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
]
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Gets or sets the list of key value pairs for dealing with custom properties.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
]
},
{
"name": "LineItems",
"kind": "optional",
"type": "array",
"description": "Gets or sets the line items.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.LineItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.LineItemModel[]",
"schema": [
{
"name": "LineItemId",
"kind": "optional",
"type": "integer",
"description": "Gets the identity of the line item.",
"format": "int32"
},
{
"name": "Code",
"kind": "optional",
"type": "string",
"description": "Gets the code of the variation content the line item represent. This property works as the connection between the line item and the variation content."
},
{
"name": "DisplayName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the display name."
},
{
"name": "PlacedPrice",
"kind": "optional",
"type": "number",
"description": "Gets the price for one item that this line item represent. This property don't take any discounts in consideration.",
"format": "double"
},
{
"name": "ExtendedPrice",
"kind": "optional",
"type": "number",
"description": "Gets the extended price for the line item. Includes order-level discount amount (which is spread over all line items in the shipment) and the line item discount amount.
",
"format": "double"
},
{
"name": "DiscountedPrice",
"kind": "optional",
"type": "number",
"description": "Gets the line item discounted price. Only calculates the price with the \"line item discount amount,\" that is, the discount for a specific item.
",
"format": "double"
},
{
"name": "Quantity",
"kind": "optional",
"type": "number",
"description": "Gets or sets the number of items this line item contains.",
"format": "double"
},
{
"name": "ReturnQuantity",
"kind": "optional",
"type": "number",
"description": "Gets or sets the returned in stock quantity.",
"format": "double"
},
{
"name": "InventoryTrackingStatus",
"kind": "optional",
"type": "integer",
"description": "Gets or sets the inventory tracking status on whether to check inventory.",
"format": "int32",
"enum": [
"0",
"1"
]
},
{
"name": "IsInventoryAllocated",
"kind": "optional",
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has allocated inventory for the {EPiServer.Commerce.Order.ILineItem.Quantity}.
"
},
{
"name": "IsGift",
"kind": "optional",
"type": "boolean",
"description": "Gets or sets a value indicating whether the line item is a gift item."
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Gets the list of key value pairs for dealing with custom properties.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
]
},
{
"name": "Payments",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PaymentModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PaymentModel[]",
"schema": [
{
"name": "Amount",
"kind": "optional",
"type": "number",
"description": "",
"format": "double"
},
{
"name": "AuthorizationCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "BillingAddressId",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "CustomerName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "ImplementationClass",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "PaymentId",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "PaymentMethodId",
"kind": "optional",
"type": "string",
"description": "",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid"
},
{
"name": "PaymentMethodName",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "PaymentTypeModel",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32",
"enum": [
"0",
"1",
"2",
"3",
"4",
"5"
]
},
{
"name": "Status",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "TransactionType",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "ValidationCode",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Custom property item.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
]
},
{
"name": "Discounts",
"kind": "optional",
"type": "array",
"description": "Gets or sets the discounts.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.DiscountModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.DiscountModel[]",
"schema": [
{
"name": "DiscountId",
"kind": "optional",
"type": "integer",
"description": "Gets or sets the discount id.",
"format": "int32"
},
{
"name": "DiscountAmount",
"kind": "optional",
"type": "number",
"description": "Gets or sets the discount amount. Either fixed money value or percentage.",
"format": "double"
},
{
"name": "DiscountCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the discount code. Also known as a coupon code."
},
{
"name": "DiscountName",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name of the discount."
},
{
"name": "DisplayMessage",
"kind": "optional",
"type": "string",
"description": "Gets or sets the display message."
},
{
"name": "DiscountValue",
"kind": "optional",
"type": "number",
"description": "Gets or sets the discount amount. The amount of discount that was applied. It will equal to DiscountAmount\r\nif it is a fixed monetary value. For the percentage based discount this value will be different.",
"format": "double"
}
]
},
{
"name": "ReturnComment",
"kind": "optional",
"type": "string",
"description": "Gets or sets the rma comment."
},
{
"name": "ReturnType",
"kind": "optional",
"type": "string",
"description": "Gets or sets the Return Type. For example can be \"Refund\", \"Exchange\" etc.
"
},
{
"name": "ReturnAuthCode",
"kind": "optional",
"type": "string",
"description": "Gets or sets the RMA auth code. Using for procedure RMA authentications."
},
{
"name": "OrderFormId",
"kind": "optional",
"type": "integer",
"description": "Gets the order form id.",
"format": "int32"
},
{
"name": "Name",
"kind": "optional",
"type": "string",
"description": "Gets or sets the name."
},
{
"name": "BillingAddressId",
"kind": "optional",
"type": "string",
"description": "Gets or sets the billing address id. The id is the name of the address in OrderAddress collection."
},
{
"name": "ShippingTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the shipping total, does not includes discounts that have been applied to each shipment.
",
"format": "double"
},
{
"name": "HandlingTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the handling total.",
"format": "double"
},
{
"name": "TaxTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the tax total.",
"format": "double"
},
{
"name": "DiscountAmount",
"kind": "optional",
"type": "number",
"description": "Gets or sets the discount amount. This amount includes shipping discounts as well.",
"format": "double"
},
{
"name": "SubTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the sub total.",
"format": "double"
},
{
"name": "Total",
"kind": "optional",
"type": "number",
"description": "Gets or sets the total.",
"format": "double"
},
{
"name": "Status",
"kind": "optional",
"type": "string",
"description": "Gets or sets the status."
},
{
"name": "RmaNumber",
"kind": "optional",
"type": "string",
"description": "Gets or sets the RMA number."
},
{
"name": "AuthorizedPaymentTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the authorized payment total.",
"format": "double"
},
{
"name": "CapturedPaymentTotal",
"kind": "optional",
"type": "number",
"description": "Gets or sets the captured payment total.",
"format": "double"
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Gets the list of key value pairs for dealing with custom properties.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
]
},
{
"name": "OrderGroupId",
"kind": "optional",
"type": "integer",
"description": "Order group ID.",
"format": "int32"
},
{
"name": "OrderNotes",
"kind": "optional",
"type": "array",
"description": "List of order notes.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.OrderNoteModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.OrderNoteModel[]",
"schema": [
{
"name": "OrderNoteId",
"kind": "optional",
"type": "integer",
"description": "Gets the order note ID.",
"format": "int32"
},
{
"name": "Created",
"kind": "optional",
"type": "string",
"description": "Gets Created date.",
"format": "date-time"
},
{
"name": "CustomerId",
"kind": "optional",
"type": "string",
"description": "Gets or sets note customer ID.",
"example": "00000000-0000-0000-0000-000000000000",
"format": "uuid"
},
{
"name": "Detail",
"kind": "optional",
"type": "string",
"description": "Gets or sets note details."
},
{
"name": "Title",
"kind": "optional",
"type": "string",
"description": "Gets or sets note title."
},
{
"name": "Type",
"kind": "optional",
"type": "string",
"description": "Gets or sets note type."
},
{
"name": "LineItemId",
"kind": "optional",
"type": "integer",
"description": "Gets or sets note related line item ID.",
"format": "int32"
}
]
},
{
"name": "Owner",
"kind": "optional",
"type": "string",
"description": "Owner name."
},
{
"name": "OwnerOrg",
"kind": "optional",
"type": "string",
"description": "Owner's organization name."
},
{
"name": "ProviderId",
"kind": "optional",
"type": "string",
"description": "Provider ID."
},
{
"name": "ShippingTotal",
"kind": "optional",
"type": "number",
"description": "Shipping total.",
"format": "double"
},
{
"name": "Status",
"kind": "optional",
"type": "string",
"description": "Status.\r\nValid values:
\n\n- AwaitingExchange
\n- Cancelled
\n- Completed
\n- InProgress
\n- OnHold
\n- PartiallyShipped.
\n
"
},
{
"name": "SubTotal",
"kind": "optional",
"type": "number",
"description": "Sub-total.
",
"format": "double"
},
{
"name": "TaxTotal",
"kind": "optional",
"type": "number",
"description": "Tax total.",
"format": "double"
},
{
"name": "Total",
"kind": "optional",
"type": "number",
"description": "Total.",
"format": "double"
},
{
"name": "Modified",
"kind": "optional",
"type": "string",
"description": "Modified date.",
"format": "date-time"
},
{
"name": "Created",
"kind": "optional",
"type": "string",
"description": "Created date.",
"format": "date-time"
},
{
"name": "Properties",
"kind": "optional",
"type": "array",
"description": "Gets the list of key value pairs for dealing with custom properties.",
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel",
"customType": "EPiServer.ServiceApi.Commerce.Models.Order.PropertyItemModel[]",
"schema": [
{
"name": "Key",
"kind": "optional",
"type": "string",
"description": "Key of the property."
},
{
"name": "Value",
"kind": "optional",
"type": "string",
"description": "Value of the property."
}
]
}
],
"modelRef": "#/components/schemas/EPiServer.ServiceApi.Commerce.Models.Order.CartModel",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "If user does not have enough permission for this request.",
"jsonExample": "",
"isExpanded": true
},
{
"statusCode": "501",
"description": "Serializable carts feature is enabled and that feature is not supported here.",
"jsonExample": "",
"isExpanded": true
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "vzBbAcYbCl-UloYK7e4pL",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url http://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount} \\\n --header 'accept: application/json'"
},
{
"id": "Dsdey440xXPwkeulvKpn4",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"http://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "pRyKYz99ZvkUsclEDsNLu",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
},
{
"id": "fWIx83lXVQlFWEp0pA6mz",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"http://localhost:64424/episerverapi/commerce/carts/search/{start}/{maxCount}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "vzBbAcYbCl-UloYK7e4pL"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Return the carts.\n[\n {\n \"AddressId\": \"\",\n \"AffiliateId\": \"00000000-0000-0000-0000-000000000000\",\n \"BillingCurrency\": \"\",\n \"CustomerId\": \"00000000-0000-0000-0000-000000000000\",\n \"CustomerName\": \"\",\n \"HandlingTotal\": \"\",\n \"InstanceId\": \"00000000-0000-0000-0000-000000000000\",\n \"MarketId\": \"\",\n \"Name\": \"\",\n \"OrderAddresses\": [\n {\n \"OrderGroupAddressId\": \"\",\n \"Name\": \"\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Organization\": \"\",\n \"Line1\": \"\",\n \"Line2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"CountryCode\": \"\",\n \"CountryName\": \"\",\n \"PostalCode\": \"\",\n \"RegionCode\": \"\",\n \"RegionName\": \"\",\n \"DaytimePhoneNumber\": \"\",\n \"EveningPhoneNumber\": \"\",\n \"FaxNumber\": \"\",\n \"Email\": \"\",\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ],\n \"OrderForms\": [\n {\n \"Shipments\": [\n {\n \"DiscountsModel\": [\n {\n \"DiscountId\": \"\",\n \"DiscountAmount\": \"\",\n \"DiscountCode\": \"\",\n \"DiscountName\": \"\",\n \"DisplayMessage\": \"\",\n \"DiscountValue\": \"\"\n }\n ],\n \"ShipmentId\": \"\",\n \"ShippingMethodId\": \"00000000-0000-0000-0000-000000000000\",\n \"ShippingMethodName\": \"\",\n \"ShippingTax\": \"\",\n \"ShippingAddressId\": \"\",\n \"ShipmentTrackingNumber\": \"\",\n \"ShippingDiscountAmount\": \"\",\n \"ShippingSubTotal\": \"\",\n \"ShippingTotal\": \"\",\n \"Status\": \"\",\n \"PrevStatus\": \"\",\n \"PickListId\": \"\",\n \"SubTotal\": \"\",\n \"WarehouseCode\": \"\",\n \"LineItems\": [\n {\n \"LineItemId\": \"\",\n \"Code\": \"\",\n \"DisplayName\": \"\",\n \"PlacedPrice\": \"\",\n \"ExtendedPrice\": \"\",\n \"DiscountedPrice\": \"\",\n \"Quantity\": \"\",\n \"ReturnQuantity\": \"\",\n \"InventoryTrackingStatus\": \"\",\n \"IsInventoryAllocated\": false,\n \"IsGift\": false,\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ],\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ],\n \"LineItems\": [\n {\n \"LineItemId\": \"\",\n \"Code\": \"\",\n \"DisplayName\": \"\",\n \"PlacedPrice\": \"\",\n \"ExtendedPrice\": \"\",\n \"DiscountedPrice\": \"\",\n \"Quantity\": \"\",\n \"ReturnQuantity\": \"\",\n \"InventoryTrackingStatus\": \"\",\n \"IsInventoryAllocated\": false,\n \"IsGift\": false,\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ],\n \"Payments\": [\n {\n \"Amount\": \"\",\n \"AuthorizationCode\": \"\",\n \"BillingAddressId\": \"\",\n \"CustomerName\": \"\",\n \"ImplementationClass\": \"\",\n \"PaymentId\": \"\",\n \"PaymentMethodId\": \"00000000-0000-0000-0000-000000000000\",\n \"PaymentMethodName\": \"\",\n \"PaymentTypeModel\": \"\",\n \"Status\": \"\",\n \"TransactionType\": \"\",\n \"ValidationCode\": \"\",\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ],\n \"Discounts\": [\n {\n \"DiscountId\": \"\",\n \"DiscountAmount\": \"\",\n \"DiscountCode\": \"\",\n \"DiscountName\": \"\",\n \"DisplayMessage\": \"\",\n \"DiscountValue\": \"\"\n }\n ],\n \"ReturnComment\": \"\",\n \"ReturnType\": \"\",\n \"ReturnAuthCode\": \"\",\n \"OrderFormId\": \"\",\n \"Name\": \"\",\n \"BillingAddressId\": \"\",\n \"ShippingTotal\": \"\",\n \"HandlingTotal\": \"\",\n \"TaxTotal\": \"\",\n \"DiscountAmount\": \"\",\n \"SubTotal\": \"\",\n \"Total\": \"\",\n \"Status\": \"\",\n \"RmaNumber\": \"\",\n \"AuthorizedPaymentTotal\": \"\",\n \"CapturedPaymentTotal\": \"\",\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ],\n \"OrderGroupId\": \"\",\n \"OrderNotes\": [\n {\n \"OrderNoteId\": \"\",\n \"Created\": \"\",\n \"CustomerId\": \"00000000-0000-0000-0000-000000000000\",\n \"Detail\": \"\",\n \"Title\": \"\",\n \"Type\": \"\",\n \"LineItemId\": \"\"\n }\n ],\n \"Owner\": \"\",\n \"OwnerOrg\": \"\",\n \"ProviderId\": \"\",\n \"ShippingTotal\": \"\",\n \"Status\": \"\",\n \"SubTotal\": \"\",\n \"TaxTotal\": \"\",\n \"Total\": \"\",\n \"Modified\": \"\",\n \"Created\": \"\",\n \"Properties\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n]"
},
{
"id": "response-1-401",
"language": "401",
"code": "// If user does not have enough permission for this request.\n"
},
{
"id": "response-2-501",
"language": "501",
"code": "// Serializable carts feature is enabled and that feature is not supported here.\n"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": ""
}
]
}