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

200

Success

401

Invalid credentials

get /v1/cart

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

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched cart listing.",
"status": "success",
"body":
{
- "carts":
  [
  - {
    "items":
    {
    "{itemId}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
    "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
    "uid": "abcdefghi123456789"
    }
  ]
},
"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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched cart.",
"status": "success",
"body":
{
- "cart":
  {
  - "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
  - "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
  - "uid": "abcdefghi123456789"
  }
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched abandoned cart listing.",
"status": "success",
"body":
{
- "carts":
  [
  - {
    "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
    "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
    "type": "abandoned",
    "user":
    {
    "email": "joe@example.com",
    "name": "Joe Smith",
    "phone": "+12345678910",
    "uid": "abcdefghi123456789"
    }
    }
  ],
- "limit": 20,
- "offset": 0,
- "total": 1
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched abandoned cart.",
"status": "success",
"body":
{
- "cart":
  {
  - "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
  - "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
  - "type": "abandoned",
  - "user":
    {
    "email": "joe@example.com",
    "name": "Joe Smith",
    "phone": "+12345678910",
    "uid": "abcdefghi123456789"
    }
  }
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched cart.",
"status": "success",
"body":
{
- "cart":
  {
  - "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
  - "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
  - "uid": "abcdefghi123456789"
  }
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched abandoned cart listing.",
"status": "success",
"body":
{
- "carts":
  [
  - {
    "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
    "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
    "type": "abandoned",
    "user":
    {
    "email": "joe@example.com",
    "name": "Joe Smith",
    "phone": "+12345678910",
    "uid": "abcdefghi123456789"
    }
    }
  ],
- "limit": 20,
- "offset": 0,
- "total": 1
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched abandoned cart listing.",
"status": "success",
"body":
{
- "carts":
  [
  - {
    "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
    "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
    "type": "abandoned",
    "user":
    {
    "email": "joe@example.com",
    "name": "Joe Smith",
    "phone": "+12345678910",
    "uid": "abcdefghi123456789"
    }
    }
  ],
- "limit": 20,
- "offset": 0,
- "total": 1
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched abandoned cart.",
"status": "success",
"body":
{
- "cart":
  {
  - "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
  - "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
  - "type": "abandoned",
  - "user":
    {
    "email": "joe@example.com",
    "name": "Joe Smith",
    "phone": "+12345678910",
    "uid": "abcdefghi123456789"
    }
  }
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched abandoned cart listing.",
"status": "success",
"body":
{
- "carts":
  [
  - {
    "items":
    {
    "{itemKey}":
    {
    "product":
    {
    "available": true,
    "dimensions":
    {
    "height": 10,
    "length": 5,
    "weight": 50,
    "width": 7
    },
    "id": "zyx987",
    "image": "https://example.com/images/ball-of-yarn.jpg",
    "name": "Ball of yarn",
    "price": 7.5,
    "type": "product",
    "url": "https://example.com/products/ball-of-yarn"
    },
    "productId": "zyx987",
    "quantity": 2
    }
    },
    "meta":
    {
    "created": "2019-03-13T02:43:34Z",
    "itemsId": "abczyx456123",
    "updated": "2019-03-15T02:43:34Z"
    },
    "type": "abandoned",
    "user":
    {
    "email": "joe@example.com",
    "name": "Joe Smith",
    "phone": "+12345678910",
    "uid": "abcdefghi123456789"
    }
    }
  ],
- "limit": 20,
- "offset": 0,
- "total": 1
}

}

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

Content type

application/json

Copy

Expand all Collapse all

{

"message": "Successfully fetched communication listing.",
"status": "success",
"body":
{
- "communications":
  [
  - {
    "method": "email",
    "recipient":
    {
    "joe@example-com":
    {
    "history":
    [
    {
    "status": "delivered",
    "timestamp":
    {
    "_nanoseconds": 0,
    "_seconds": 1469145600
    }
    },
    {
    "status": "opened",
    "timestamp":
    {
    "_nanoseconds": 0,
    "_seconds": 1469155600
    }
    }
    ],
    "status": "opened"
    }
    },
    "service": "mailgun",
    "user":
    {
    "email": "joe@example.com",
    "uid": "abcdef123456"
    }
    }
  ],
- "limit": 20,
- "offset": 0,
- "total": 1
}

}