Commerce Admin API (0.1.0)

Download OpenAPI specification:Download

static.tools support: support@static.tools

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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched abandoned cart listing.",
  • "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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched communication listing.",
  • "status": "success",
  • "body": {
    }
}

List a specific customer's orders.

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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched order listing.",
  • "status": "success",
  • "body": {
    }
}

order

List a specific customer's orders.

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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched order listing.",
  • "status": "success",
  • "body": {
    }
}

List orders.

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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched order listing.",
  • "status": "success",
  • "body": {
    }
}

Fetch a specific order.

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

Private API Key for the Commerce instance.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully fetched order.",
  • "status": "success",
  • "body": {
    }
}

product

List products.

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

Response samples

Content type
application/json
{}

Fetch a specific product.

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

Private API Key for the Commerce instance.

Responses

Response samples

Content type
application/json
{}

report

List daily reports.

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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report listing.",
  • "status": "success",
  • "body": {
    }
}

List monthly reports.

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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report listing.",
  • "status": "success",
  • "body": {
    }
}

List yearly reports.

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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report listing.",
  • "status": "success",
  • "body": {
    }
}

List monthly reports for a specific year.

path Parameters
year
required
integer
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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report listing.",
  • "status": "success",
  • "body": {
    }
}

List daily reports for a specific month.

path Parameters
year
required
integer
month
required
integer
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

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report listing.",
  • "status": "success",
  • "body": {
    }
}

Fetch a yearly report.

path Parameters
year
required
integer
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report.",
  • "status": "success",
  • "body": {
    }
}

Fetch a monthly report.

path Parameters
year
required
integer
month
required
integer
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report.",
  • "status": "success",
  • "body": {
    }
}

Fetch a daily report.

path Parameters
year
required
integer
month
required
integer
day
required
integer
header Parameters
CG-API-Key
required
string

Private API Key for the Commerce instance.

Responses

Response samples

Content type
application/json
{
  • "message": "Successfully fetched report.",
  • "status": "success",
  • "body": {
    }
}