List Abandoned Carts

Request

Query Params

page

number

required

pagination, number of page for every call.

Example:

5

page_size

number

required

number of records for every page with max 100 records.

Example:

10

phase

enum<string>

optional

The ordering phase in which the cart was abandoned.

Allowed values:

newloginshipping_addressshipping_methodpayment_methodverificationcompleted

Example:

new

search_term

string

optional

products_count

number

optional

date_from

string

optional

example: '2021-01-01'

date_to

string

optional

example: '2021-01-01'

cart_total

number

optional

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:

en

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.zid.sa/v1/managers/store/abandoned-carts?page&page_size&phase&search_term&products_count&date_from&date_to&cart_total' \
--header 'Authorization: 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' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Accept-Language;'

Responses

🟢200List of Abandoned Carts with brief details.

application/json

Body

Brief representation of an abandoned cart as seen in the response to the [List Abandoned Carts](../reference/merchant-api.yaml/paths/~1managers~1store~1abandoned-carts/get) endpoint. This version provides a concise overview of the cart without all the detailed properties. To get a detailed version of a certain cart, use the [Get Abandoned Cart Details](../reference/merchant-api.yaml/paths/~1managers~1store~1abandoned-carts~1{cart-id}/get) endpoint.

id

string

optional

Unique identifier for the abandoned cart.

Example:

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

store_id

string

optional

Unique identifier for the store.

Example:

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

session_id

string

optional

Session identifier for the abandoned cart.

Example:

WS56eLg6j2J2KAFB6KkX0B3uJSs3oINu

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

cart_id

string

optional

Cart identifier.

Example:

237245

order_id

integer

optional

Unique identifier for the order associated with the abandoned cart, if any.

Example:

12675

phase

string

optional

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.

customer_id

integer

optional

Unique identifier for the customer.

Example:

6

customer_name

string

optional

Name of the customer.

Example:

Abdul Rahman

customer_email

string

optional

Email address of the customer.

Example:

abdulrahman3344@gmai.com

customer_mobile

string

optional

Mobile number of the customer.

Example:

966500000005

city_id

integer

optional

Identifier for the city associated with the customer's address.

Example:

1

products_count

integer

optional

Number of products in the abandoned cart.

Example:

1

reminders_count

integer

optional

Number of reminders sent for the abandoned cart.

Example:

11

cart_total

number <float>

optional

Total value of the abandoned cart.

Example:

11.5

cart_total_string

string

optional

Total value of the abandoned cart in string format with currency.

Example:

11.50 SAR

whatsapp_message

string

optional

Custom message from the merchant to the customer regarding the abandoned cart items.

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

Example

{
  "id": "18a40fc6-2381-4ab2-9f72-467e6c39a599",
  "store_id": "3dfc16e6-ad19-4126-9c2a-5e4a7fb73051",
  "session_id": "WS56eLg6j2J2KAFB6KkX0B3uJSs3oINu",
  "url": "https://store.zidtest.com/checkout/fromBasket/WS56eLg6j2J2KAFB6KkX0B3uJSs3oINu",
  "cart_id": "237245",
  "order_id": 12675,
  "phase": "string",
  "customer_id": 6,
  "customer_name": "Abdul Rahman",
  "customer_email": "abdulrahman3344@gmai.com",
  "customer_mobile": "966500000005",
  "city_id": 1,
  "products_count": 1,
  "reminders_count": 11,
  "cart_total": 11.5,
  "cart_total_string": "11.50 SAR",
  "whatsapp_message": "string",
  "created_at": "2023-07-12 08:17:02",
  "updated_at": "2023-07-19 09:01:18",
  "source": "catalog"
}