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

200
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
401

Content type

application/json

{"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
}
}

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

200
400
401

Content type

application/json

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

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

200
400
401

Content type

application/json

{"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
}
}

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

200
401

Content type

application/json

{"message": "Successfully fetched customer listing.",
"status": "success",
"body": {"customers": [{"email": "joe@example.com",
"name": "Joe Smith",
"orderCount": 3,
"orderList": ["abc123",
"abc124",
"abc125"
],
"phone": "+123456789",
"provider": "google",
"spent": 459.43,
"uid": "abcdefghi123456789"
}
]
},
"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

200
400
401

Content type

application/json

{"message": "Successfully fetched customer listing.",
"status": "success",
"body": {"customer": {"email": "joe@example.com",
"name": "Joe Smith",
"orderCount": 3,
"orderList": ["abc123",
"abc124",
"abc125"
],
"phone": "+123456789",
"provider": "google",
"spent": 459.43,
"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

Response samples

200
400
401

Content type

application/json

{"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

Response samples

200
400
401

Content type

application/json

{"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
}
}

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

200
400
401

Content type

application/json

{"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
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched order listing.",
"status": "success",
"body": {"orders": [{"audit": {"shipping": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
}
],
"tax": [{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"user": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef123456789"
}
},
"company": {"city": "Melbourne",
"country": "AU",
"lines": ["Level 2/696 Bourke Street"
],
"postcode": 3000,
"state": "VIC",
"name": "Cold & Goji"
},
"id": "CG-10001",
"imported": false,
"key": "abcdef1234567",
"meta": {"created": "2018-05-17T09:44:40Z"
},
"order": {"addresses": {"billing": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
},
"shipping": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
}
},
"contact": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910
},
"items": {"{itemKey}": {"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": {"currency": "AUD",
"formatted": {"total": "$100.00",
"unit": "$10.00"
},
"total": 100,
"unit": 10
},
"quantity": 10,
"sku": "yarn-1234567"
}
},
"modifiers": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
},
{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"notes": {"order": "Please leave the package at the door. Thanks."
},
"subtotal": {"currency": "AUD",
"formatted": "$100.00",
"price": 100
},
"total": {"currency": "AUD",
"formatted": "$117.95",
"total": 117.95
}
},
"payment": {"card": {"brand": "Mastercard",
"last4": "1234"
},
"charge": {"id": "ch_12345678910"
},
"cost": {"currency": "AUD",
"formatted": "$117.95",
"price": 117.95
},
"id": "ch_12345678910",
"processor": "stripe",
"status": "shipped"
}
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched order listing.",
"status": "success",
"body": {"orders": [{"audit": {"shipping": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
}
],
"tax": [{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"user": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef123456789"
}
},
"company": {"city": "Melbourne",
"country": "AU",
"lines": ["Level 2/696 Bourke Street"
],
"postcode": 3000,
"state": "VIC",
"name": "Cold & Goji"
},
"id": "CG-10001",
"imported": false,
"key": "abcdef1234567",
"meta": {"created": "2018-05-17T09:44:40Z"
},
"order": {"addresses": {"billing": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
},
"shipping": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
}
},
"contact": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910
},
"items": {"{itemKey}": {"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": {"currency": "AUD",
"formatted": {"total": "$100.00",
"unit": "$10.00"
},
"total": 100,
"unit": 10
},
"quantity": 10,
"sku": "yarn-1234567"
}
},
"modifiers": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
},
{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"notes": {"order": "Please leave the package at the door. Thanks."
},
"subtotal": {"currency": "AUD",
"formatted": "$100.00",
"price": 100
},
"total": {"currency": "AUD",
"formatted": "$117.95",
"total": 117.95
}
},
"payment": {"card": {"brand": "Mastercard",
"last4": "1234"
},
"charge": {"id": "ch_12345678910"
},
"cost": {"currency": "AUD",
"formatted": "$117.95",
"price": 117.95
},
"id": "ch_12345678910",
"processor": "stripe",
"status": "shipped"
}
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
401

Content type

application/json

{"message": "Successfully fetched order listing.",
"status": "success",
"body": {"orders": [{"audit": {"shipping": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
}
],
"tax": [{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"user": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef123456789"
}
},
"company": {"city": "Melbourne",
"country": "AU",
"lines": ["Level 2/696 Bourke Street"
],
"postcode": 3000,
"state": "VIC",
"name": "Cold & Goji"
},
"id": "CG-10001",
"imported": false,
"key": "abcdef1234567",
"meta": {"created": "2018-05-17T09:44:40Z"
},
"order": {"addresses": {"billing": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
},
"shipping": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
}
},
"contact": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910
},
"items": {"{itemKey}": {"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": {"currency": "AUD",
"formatted": {"total": "$100.00",
"unit": "$10.00"
},
"total": 100,
"unit": 10
},
"quantity": 10,
"sku": "yarn-1234567"
}
},
"modifiers": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
},
{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"notes": {"order": "Please leave the package at the door. Thanks."
},
"subtotal": {"currency": "AUD",
"formatted": "$100.00",
"price": 100
},
"total": {"currency": "AUD",
"formatted": "$117.95",
"total": 117.95
}
},
"payment": {"card": {"brand": "Mastercard",
"last4": "1234"
},
"charge": {"id": "ch_12345678910"
},
"cost": {"currency": "AUD",
"formatted": "$117.95",
"price": 117.95
},
"id": "ch_12345678910",
"processor": "stripe",
"status": "shipped"
}
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched order.",
"status": "success",
"body": {"order": [{"audit": {"shipping": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
}
],
"tax": [{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"user": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef123456789"
}
},
"company": {"city": "Melbourne",
"country": "AU",
"lines": ["Level 2/696 Bourke Street"
],
"postcode": 3000,
"state": "VIC",
"name": "Cold & Goji"
},
"id": "CG-10001",
"imported": false,
"key": "abcdef1234567",
"meta": {"created": "2018-05-17T09:44:40Z"
},
"order": {"addresses": {"billing": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
},
"shipping": {"city": "Sydney",
"country": "AU",
"lines": ["123 Example Street"
],
"postcode": 2000,
"state": "NSW"
}
},
"contact": {"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910
},
"items": {"{itemKey}": {"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": {"currency": "AUD",
"formatted": {"total": "$100.00",
"unit": "$10.00"
},
"total": 100,
"unit": 10
},
"quantity": 10,
"sku": "yarn-1234567"
}
},
"modifiers": [{"cost": {"currency": "AUD",
"formatted": "$7.95",
"price": 7.95,
"name": "Auspost Regular",
"service": {"name": "Australia Post Parcel Post",
"provider": "auspost"
},
"type": "shipping"
}
},
{"cost": {"currency": "AUD",
"formatted": "$10.00",
"price": 10
},
"name": "GST (10%)",
"rate": 0.1,
"type": "tax"
}
],
"notes": {"order": "Please leave the package at the door. Thanks."
},
"subtotal": {"currency": "AUD",
"formatted": "$100.00",
"price": 100
},
"total": {"currency": "AUD",
"formatted": "$117.95",
"total": 117.95
}
},
"payment": {"card": {"brand": "Mastercard",
"last4": "1234"
},
"charge": {"id": "ch_12345678910"
},
"cost": {"currency": "AUD",
"formatted": "$117.95",
"price": 117.95
},
"id": "ch_12345678910",
"processor": "stripe",
"status": "shipped"
}
}
]
}
}

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

200
401

Content type

application/json

{"message": "Successfully fetched product listing.",
"status": "success",
"body": {"products": [{"available": true,
"dimensions": {"height": 5,
"length": 10,
"weight": 105,
"width": 10
},
"id": "abcdef1234567",
"image": "https://example.com/images/ball-of-yarn.jpg",
"name": "Ball of Yarn",
"price": 8.5,
"type": "product",
"url": "https://example.com/products/ball-of-yarn"
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched product.",
"status": "success",
"body": {"product": {"available": true,
"dimensions": {"height": 5,
"length": 10,
"weight": 105,
"width": 10
},
"id": "abcdef1234567",
"image": "https://example.com/images/ball-of-yarn.jpg",
"name": "Ball of Yarn",
"price": 8.5,
"type": "product",
"url": "https://example.com/products/ball-of-yarn"
}
}
}

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

200
401

Content type

application/json

{"message": "Successfully fetched report listing.",
"status": "success",
"body": {"reports": [{"day": "01",
"month": "01",
"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "day",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
401

Content type

application/json

{"message": "Successfully fetched report listing.",
"status": "success",
"body": {"reports": [{"month": "01",
"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "month",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
401

Content type

application/json

{"message": "Successfully fetched report listing.",
"status": "success",
"body": {"reports": [{"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "year",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched report listing.",
"status": "success",
"body": {"reports": [{"month": "01",
"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "month",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched report listing.",
"status": "success",
"body": {"reports": [{"day": "01",
"month": "01",
"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "day",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
],
"limit": 20,
"offset": 0,
"total": 1
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched report.",
"status": "success",
"body": {"report": {"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "year",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched report.",
"status": "success",
"body": {"report": {"month": "01",
"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "month",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
}
}

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

200
400
401

Content type

application/json

{"message": "Successfully fetched report.",
"status": "success",
"body": {"report": {"day": "01",
"month": "01",
"orders": ["abcdef1234567"
],
"timestamp": {"_nanoseconds": 0,
"_seconds": 1546300800
},
"top": {"client": [{"amount": 117.95,
"email": "joe@example.com",
"name": "Joe Smith",
"phone": 12345678910,
"provider": ["google"
],
"uid": "abcdef1234567"
}
],
"product": [{"amount": 100,
"count": 10,
"properties": {"id": "zyx987",
"image": "https://example.com/images/ball-of-yarn",
"name": "Ball of yarn",
"price": {"currency": "AUD",
"formatted": {"total": "$10.00",
"unit": "$10.00"
},
"total": 10,
"unit": 10
},
"sku": "yarn-1234567"
}
}
]
},
"total": {"amount": 117.95,
"count": 1,
"refund": 0,
"shipping": 7.95,
"tax": {"additional": 10,
"included": 0
}
},
"type": "day",
"users": {"new": 1,
"registered": 1
},
"year": "2019"
}
}
}