Searchs for orders.

1 min

POST

/api/episerver/v3.0/carts/search

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsonapplication/problem+json

Body Parameters

bodycartSearchFilterrequired
Description
The seach parameters
- marketIdsstring[]
  Description
  Specified that only orders created in these markets should be returned.
- modifiedFromstring<date-time>
  Description
  Specifies the time that returned orders were modified after.
  Format
  date-time
- modifiedTostring<date-time>
  Description
  Specifies the time that returned orders were modified before.
  Format
  date-time
- customerIdstring<uuid>
  Description
  Specifies that only carts/orders created by specified customer should be returned.
  Format
  uuid
- startingIndexinteger<int32>
  Description
  Gets or sets the starting index.
  Format
  int32
- recordsToRetrieveinteger<int32>
  Description
  Gets or sets the number of records to retrieve.
  Format
  int32
- searchTermstring
  Description
  The customer name or email to search for

Responses

200OK

cart[]
Description
Represents a cart.
- idinteger<int32>
  Description
  The cart id.
  Format
  int32
- namestringrequired
  Description
  The cart name.
- customerIdstring<uuid>
  Description
  The customer the cart belongs to.
  Format
  uuid
- marketstringrequired
  Description
  The market in which the cart is valid.
- currencystringrequired
  Description
  The currency of the market in which the cart is valid.
- lastUpdatedstring<date-time>
  Description
  The last updated timestamp.
  Format
  date-time
- shipmentsshipment[]
  Description
  The shipments.
  - idinteger<int32>
    Description
    The shipping id.
    Format
    int32
  - shippingAddressaddress
    Description
    Represents a customer address todo: associate with commerce customers via business foundation? todo: add more properties.
    - firstNamestring
      Description
      The first name.
    - lastNamestring
      Description
      The last name.
    - line1string
      Description
      The line1.
    - line2string
      Description
      The line2.
    - citystring
      Description
      The city.
    - countryNamestring
      Description
      The country name.
    - countryCodestring
      Description
      The country code.
    - postalCodestring
      Description
      The postal code
    - regionNamestring
      Description
      The region name/state
    - emailstring
      Description
      The email.
    - phoneNumberstring
      Description
      The phone number.
    - namestring
      Description
      The name.
  - shippingMethodIdstring<uuid>
    Description
    The shipping method id.
    Format
    uuid
  - lineItemslineItem[]
    Description
    the line items that belong to the cart.
    - idinteger<int32>
      Description
      The line item id.
      Format
      int32
    - contentIdstring<uuid>
      Description
      The content id.
      Format
      uuid
    - codestring
      Description
      The sku code.
    - placedPricenumber<decimal>
      Description
      The placed price.
      Format
      decimal
    - quantitynumber<decimal>required
      Description
      The quantity.
      Format
      decimal
    - displayNamestring
      Description
      The display name.
    - isGiftboolean
      Description
      Indicates whether the line item is a gift item.
- paymentspayment[]
  Description
  The payments.
  - amountnumber<decimal>
    Description
    Gets or sets the amount.
    Format
    decimal
  - authorizationCodestring
    Description
    Gets or sets the authorization code.
  - billingAddressaddress
    Description
    Represents a customer address todo: associate with commerce customers via business foundation? todo: add more properties.
    - firstNamestring
      Description
      The first name.
    - lastNamestring
      Description
      The last name.
    - line1string
      Description
      The line1.
    - line2string
      Description
      The line2.
    - citystring
      Description
      The city.
    - countryNamestring
      Description
      The country name.
    - countryCodestring
      Description
      The country code.
    - postalCodestring
      Description
      The postal code
    - regionNamestring
      Description
      The region name/state
    - emailstring
      Description
      The email.
    - phoneNumberstring
      Description
      The phone number.
    - namestring
      Description
      The name.
  - savedBillingAddressNamestring
    Description
    Gets or sets the billing address.
  - customerNamestring
    Description
    Gets or sets the name of the customer.
  - paymentIdinteger<int32>
    Description
    Gets the payment identifier.
    Format
    int32
  - systemKeywordstring
    Description
    Gets or sets the name of the payment method.
  - paymentTypestring
    Description
    Gets or sets the type of the payment.
  - providerTransactionIDstring
    Description
    Gets or sets the provider transaction identifier.
  - statusstring
    Description
    Gets or sets the status.
  - transactionIDstring
    Description
    Gets or sets the transaction identifier.
  - transactionTypestring
    Description
    Gets or sets the type of the transaction.
  - validationCodestring
    Description
    Gets or sets the validation code.
  - extendedPropertiesextendedProperty[]
    Description
    Custom properties added by partner or customer.
    - namestring
      Description
      Name of the property
    - valuestring
      Description
      The property value.
- couponCodesstring[]
  Description
  The coupon codes.

400Bad Request

403Forbidden

404Not Found

curl

curl --request POST \
     --url /api/episerver/v3.0/carts/search \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/episerver/v3.0/carts/search", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/api/episerver/v3.0/carts/search")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/api/episerver/v3.0/carts/search"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
[
  {
    "id": "",
    "name": "",
    "customerId": "",
    "market": "",
    "currency": "",
    "lastUpdated": "",
    "shipments": [
      {
        "id": "",
        "shippingAddress": {
          "firstName": "",
          "lastName": "",
          "line1": "",
          "line2": "",
          "city": "",
          "countryName": "",
          "countryCode": "",
          "postalCode": "",
          "regionName": "",
          "email": "",
          "phoneNumber": "",
          "name": ""
        },
        "shippingMethodId": "",
        "lineItems": [
          {
            "id": "",
            "contentId": "",
            "code": "",
            "placedPrice": "",
            "quantity": "",
            "displayName": "",
            "isGift": false
          }
        ]
      }
    ],
    "payments": [
      {
        "amount": "",
        "authorizationCode": "",
        "billingAddress": {
          "firstName": "",
          "lastName": "",
          "line1": "",
          "line2": "",
          "city": "",
          "countryName": "",
          "countryCode": "",
          "postalCode": "",
          "regionName": "",
          "email": "",
          "phoneNumber": "",
          "name": ""
        },
        "savedBillingAddressName": "",
        "customerName": "",
        "paymentId": "",
        "systemKeyword": "",
        "paymentType": "",
        "providerTransactionID": "",
        "status": "",
        "transactionID": "",
        "transactionType": "",
        "validationCode": "",
        "extendedProperties": [
          {
            "name": "",
            "value": ""
          }
        ]
      }
    ],
    "couponCodes": [
      ""
    ]
  }
]

400

// Bad Request

403

// Forbidden

404

// Not Found