Get Abandoned Cart Details

This endpoint fetches comprehensive details about an abandoned cart, identified
by its unique ID. An abandoned cart is a shopping cart to which items have been added
but is left incomplete by the customer. A cart is marked as abandoned after
10 minutes of inactivity.

Along with detailed information about the cart and its contents, this endpoint provides
the url field, which is the direct link to the abandoned cart. This enables merchants
to easily retarget customers with a direct link to their uncompleted purchase,
enhancing the chances of converting these abandoned carts into completed transactions.

The response also includes the customer's name and contact details, providing additional context
for retargeting efforts and potential follow-up communications.

The response conforms to the Abandoned Cart schema, providing comprehensive details
of the cart, its associated customer, and the products within it.

🔑Scopes

abandoned_carts.read - Abandoned Carts Read

Request

Path Params

cart-id

string

required

Header Params

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Details of the Abandoned Cart given its `cart-id`.

application/json

Body

This schema provides a detailed representation of an abandoned cart. An abandoned cart is a shopping cart where items have been added but the purchase has not been finalized. The cart is considered abandoned after **10 minutes** of inactivity. This schema outlines all the relevant information about the cart, the customer, and the products involved.

status

string

optional

The status of the request.

Example:

object

abandoned_cart

object

optional

Details of the abandoned cart.

string

optional

Unique identifier for the abandoned cart.

Example:

18a40fc6-2381-4ab2-9f72-467e6c39a599

url

string

optional

URL to access the abandoned cart and continue the checkout process. This is crucial for re-engaging customers.

Example:

https://store.zidtest.com/checkout/fromBasket/WS56eLg6j2J2KAFB6KkX0B3uJSs3oINu

store_id

string

optional

Unique identifier for the store.

Example:

3dfc16e6-ad19-4126-9c2a-5e4a7fb73051

store_name

string

optional

Name of the store.

Example:

Zid Store on Testing

store_logo

string

optional

URL of the store's logo.

Example:

https://zid-testing.s3.eu-west-1.amazonaws.com/3dfc16e6-ad19-4126-9c2a-5e4a7fb73051/d24a04a4-483c-4cfd-937e-35e7f419d127-200x.png

store_url

string

optional

URL of the store.

Example:

https://store.zidtest.com/

products_count

integer

optional

Number of products in the abandoned cart.

Example:

products

array [object {14}]

optional

List of products in the abandoned cart.

city

object (City)

optional

history

array [object {5}]

optional

History of actions related to the abandoned cart.

phase

string

required

Current phase of the abandoned cart. This indicates the last step the customer reached before abandoning the cart.
The phases are as follows:

completed: The cart has been converted into an order.

shipping_address: The customer has provided a shipping address.

verification: The customer is in the verification process.

shipping_method: The customer has chosen a shipping method.

new: The cart has been recently created but no further action has been taken.

login: The customer is prompted to log in or register.

payment-method: The customer has selected a payment method but has not completed the purchase.

Example:

payment_method

customer_id

string

required

A unique identifier for the customer.

Example:

000000000

customer_name

string

required

The full name of the customer.

Example:

test customer name

customer_email

string

required

The email address of the customer.

Example:

testemail@gmail.com

customer_mobile

string

required

The customer's mobile phone number.

Example:

966555555555

reminders_count

string

required

The number of reminders sent to the customer regarding the transaction or payment.

Example:

cart_total

string

required

The total cost of items in the cart, represented as a floating-point number.

Example:

239.00

cart_total_string

string

required

The total cost of items in the cart, formatted as a string with the currency (e.g., "SAR").

Example:

239.00 SAR

created_at

string <date-time>

optional

Timestamp when the cart was created.

Example:

2023-07-12 08:17:02

updated_at

string <date-time>

optional

Timestamp when the cart was last updated.

Example:

2023-07-19 09:01:18

source

string

required

Indicating the source or channel of the order. This can be one of several predefined values:

catalog: Order was made through a product catalog or online storefront.

mobile_app: Order was made through the store's mobile application.

Example:

catalog

message

object

optional

Message related to the request status.

type

string

optional

Type of the message.

Example:

object

code

string

optional

Code associated with the message.

name

string

optional

Name of the message.

description

string

optional

Detailed description of the message.

Example

{
  "status": "object",
  "abandoned_cart": {
    "id": "0b130951b-5a6b-4420-beca-0b130951bff0",
    "url": "https://storeurl.com/checkout/fromBasket/43515:0b130951bffb757bc51efbda",
    "store_id": "83e0499c-85ec-440e-9200-6b94f7ab58c6",
    "store_name": "store name",
    "store_logo": "https://media.zid.store/83e0499c-85ec-440e-9200-6b94f7ab58c6/c1c2952f-a9b3-42d9-be8b-8e5e6ad68150-200x.png",
    "store_url": "https://storeurl.com/",
    "products_count": 1,
    "products": [
      {
        "id": 900584062,
        "product_id": "0b00ssx2ee9c3141c4cd0d955dce5deb8c",
        "product_url": "https://storeurl.com/products/0b00ssx2ee9c3141c4cd0d955dce5deb8c",
        "sku": "HJRMR0500R",
        "name": "AlSamra honey ",
        "custom_field": [],
        "price": 239.000935,
        "price_string": "239.00 SAR",
        "additions_price": 0,
        "additions_price_string": "0.00 SAR",
        "quantity": 1,
        "total": 239.000935,
        "total_string": "239.00 SAR",
        "images": [
          {
            "id": "147d0aea-b708-49f7-bdee-c1cd940f6f1d",
            "origin": "https://media.zid.store/thumbs/83e0499c-85ec-440e-9200-6b94f7ab58c6/147d0aea-b708-49f7-bdee-c1cd940f6f1d-thumbnail-500x500-70.jpg",
            "thumbs": {
              "fullSize": "https://media.zid.store/83e0499c-85ec-440e-9200-6b94f7ab58c6/147d0aea-b708-49f7-bdee-c1cd940f6f1d.jpg",
              "thumbnail": "https://media.zid.store/thumbs/83e0499c-85ec-440e-9200-6b94f7ab58c6/147d0aea-b708-49f7-bdee-c1cd940f6f1d-thumbnail-370x370-70.jpg",
              "small": "https://media.zid.store/thumbs/83e0499c-85ec-440e-9200-6b94f7ab58c6/147d0aea-b708-49f7-bdee-c1cd940f6f1d-thumbnail-500x500-70.jpg",
              "medium": "https://media.zid.store/thumbs/83e0499c-85ec-440e-9200-6b94f7ab58c6/147d0aea-b708-49f7-bdee-c1cd940f6f1d-thumbnail-770x770-70.jpg",
              "large": "https://media.zid.store/thumbs/83e0499c-85ec-440e-9200-6b94f7ab58c6/147d0aea-b708-49f7-bdee-c1cd940f6f1d-thumbnail-1000x1000-70.jpg"
            }
          }
        ]
      }
    ],
    "city": {
      "id": 71,
      "national_id": 18,
      "name": "Jeddah",
      "priority": 9,
      "country_id": 184,
      "country_name": "Saudi Arabia",
      "country_code": "SA",
      "ar_name": "جدة",
      "en_name": "Jeddah"
    },
    "order_id": null,
    "history": [
      {
        "uuid": "becacc4a-5645-beca-925b-cda89beca5bf",
        "abandoned_cart_id": "936beca-5a6b-4420-beca-0b144201bff0",
        "type": "Created Successfully",
        "created_at": "2025-01-13T06:20:24.000000Z",
        "updated_at": "2025-01-13T06:20:24.000000Z"
      },
      {
        "uuid": "becacc4a-5645-beca-925b-cda89beca5bf",
        "abandoned_cart_id": "936beca-5a6b-4420-beca-0b144201bff0",
        "type": "Created Successfully",
        "created_at": "2025-01-13T06:17:34.000000Z",
        "updated_at": "2025-01-13T06:17:34.000000Z"
      },
      {
        "uuid": "becacc4a-5645-beca-925b-cda89beca5bf",
        "abandoned_cart_id": "936beca-5a6b-4420-beca-0b144201bff0",
        "type": "Created Successfully",
        "created_at": "2025-01-13T06:14:51.000000Z",
        "updated_at": "2025-01-13T06:14:51.000000Z"
      },
      {
        "uuid": "becacc4a-5645-beca-925b-cda89beca5bf",
        "abandoned_cart_id": "936beca-5a6b-4420-beca-0b144201bff0",
        "type": "Created Successfully",
        "created_at": "2025-01-13T06:19:24.000000Z",
        "updated_at": "2025-01-13T06:19:24.000000Z"
      },
      {
        "uuid": "becacc4a-5645-beca-925b-cda89beca5bf",
        "abandoned_cart_id": "936beca-5a6b-4420-beca-0b144201bff0",
        "type": "Created Successfully",
        "created_at": "2025-01-13T06:18:34.000000Z",
        "updated_at": "2025-01-13T06:18:34.000000Z"
      }
    ],
    "phase": "payment_method",
    "customer_id": 000000000,
    "customer_name": "test customer name",
    "customer_email": "testemail@gmail.com",
    "customer_mobile": "966555555555",
    "reminders_count": 0,
    "cart_total": 239.0009,
    "cart_total_string": "239.00 SAR",
    "created_at": "2025-01-13 06:10:48",
    "updated_at": "2025-01-13 06:12:44",
    "source": "catalog"
  },
  "message": {
    "type": "object",
    "code": null,
    "name": null,
    "description": null
  }
}