Commerce REST API (0.1.0)

Download OpenAPI specification:Download

Static Tools Support: support@coldandgoji.com

cart

List carts.

query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

401

Invalid credentials

get /v1/cart
https://commerce.static.tools//v1/cart

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched cart listing.",
  • "status": "success",
  • "body":
    {
    },
  • "limit": 20,
  • "offset": 0,
  • "total": 1
}

Fetch a specific cart.

path Parameters
cartId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/cart/{cartId}
https://commerce.static.tools//v1/cart/{cartId}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched cart.",
  • "status": "success",
  • "body":
    {
    }
}

List abandoned carts.

query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

401

Invalid credentials

get /v1/carts/abandoned
https://commerce.static.tools//v1/carts/abandoned

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart listing.",
  • "status": "success",
  • "body":
    {
    }
}

Fetch a specific abandoned cart.

path Parameters
abandonedCartId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/carts/abandoned/{abandonedCartId}
https://commerce.static.tools//v1/carts/abandoned/{abandonedCartId}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart.",
  • "status": "success",
  • "body":
    {
    }
}

Fetch a specific customer's cart.

path Parameters
customerId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}/cart
https://commerce.static.tools//v1/customer/{customerId}/cart

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched cart.",
  • "status": "success",
  • "body":
    {
    }
}

List a specific customer's abandoned carts.

path Parameters
customerId
required
string
query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}/carts/abandoned
https://commerce.static.tools//v1/customer/{customerId}/carts/abandoned

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart listing.",
  • "status": "success",
  • "body":
    {
    }
}

abandoned cart

List abandoned carts.

query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

401

Invalid credentials

get /v1/carts/abandoned
https://commerce.static.tools//v1/carts/abandoned

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart listing.",
  • "status": "success",
  • "body":
    {
    }
}

Fetch a specific abandoned cart.

path Parameters
abandonedCartId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/carts/abandoned/{abandonedCartId}
https://commerce.static.tools//v1/carts/abandoned/{abandonedCartId}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart.",
  • "status": "success",
  • "body":
    {
    }
}

List a specific customer's abandoned carts.

path Parameters
customerId
required
string
query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}/carts/abandoned
https://commerce.static.tools//v1/customer/{customerId}/carts/abandoned

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart listing.",
  • "status": "success",
  • "body":
    {
    }
}

communication

List communications.

query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

401

Invalid credentials

get /v1/communication
https://commerce.static.tools//v1/communication

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched communication listing.",
  • "status": "success",
  • "body":
    {
    }
}

Fetch a specific communication.

path Parameters
communicationId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/communication/{communicationId}
https://commerce.static.tools//v1/communication/{communicationId}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched communication.",
  • "status": "success",
  • "body":
    {
    }
}

List a specific customer's communications.

path Parameters
customerId
required
string
query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}/communication
https://commerce.static.tools//v1/customer/{customerId}/communication

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched communication listing.",
  • "status": "success",
  • "body":
    {
    }
}

customer

List customers.

query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

401

Invalid credentials

get /v1/customer
https://commerce.static.tools//v1/customer

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched customer listing.",
  • "status": "success",
  • "body":
    {
    },
  • "limit": 20,
  • "offset": 0,
  • "total": 1
}

Fetch a specific customer.

path Parameters
customerId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}
https://commerce.static.tools//v1/customer/{customerId}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched customer listing.",
  • "status": "success",
  • "body":
    {
    }
}

Fetch a specific customer's cart.

path Parameters
customerId
required
string
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}/cart
https://commerce.static.tools//v1/customer/{customerId}/cart

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched cart.",
  • "status": "success",
  • "body":
    {
    }
}

List a specific customer's abandoned carts.

path Parameters
customerId
required
string
query Parameters
limit
integer [ 1 .. 250 ]
Default: 20

The number of objects to list.

offset
integer
Default: 0

The number of objects to skip at the beginning of the list.

header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

200

Success

400

Invalid request

401

Invalid credentials

get /v1/customer/{customerId}/carts/abandoned
https://commerce.static.tools//v1/customer/{customerId}/carts/abandoned

Response samples

application/json
Copy
Expand all Collapse all
{
  • "message": "Successfully fetched abandoned cart listing.",
  • "status": "success",
  • "body":
    {