ComicBase’s E-Commerce APIs give you an easy way to integrate your ComicBase Database with a 3rd party E-Commerce system. With just two simple web calls, you can have your E-Commerce software automatically post sales made to the ComicBase servers. Then, when you next use ComicBase on your local desktop, those sales transactions can automatically update your local inventory database to keep the systems in sync, and allow for local reporting of sales, whether they’re made from ComicBase’s built-in POS system, Atomic Avenue, or your 3rd party E-Commerce solution.

Getting Started

  • Like the ComicBase Mobile app, E-Commerce API access requires an active ComicBase subscription to either the ComicBase Professional or Archive Editions.

    For most E-Commerce users, we’d recommend choosing the Archive Edition, as that edition has the ability to create ComicBase Interchange Files which contain information on your entire inventory, along with with linked images of all your items. This will give you the most straightforward path to loading your inventory into a 3rd party E-Commerce solution.
  • The following APIs will reference both your API credentials and the ID of the database in question. These can be found on your ComicBase Profile page.

Notes on Parameters

Unless otherwise specified, all string parameters are expected in UTF-8 encoding.

Parameters containing script, tags, or suspicious character sequences will be rejected and return an error code for the API call.

Dates should be formatted in ISO format, e.g. “2022-06-17” for June 17th, 2022

DateTimes should be formatted in ISO format, e.g. “2022-06-17 13:21:15” to represent the time 1:21 and 15 seconds in the afternoon on June 17, 2022

Unless stated otherwise, all routines which complete (HTTP status 200) will return a WebAPIResult


GetAuthHeader

Required. Use this first to request access to the API interface and get an authorization header which should be appended to any subsequent API calls. The authorization header will expire after a period of unuse.

https://comicbase.com/api/GetAuthHeader
POST with the following parameters:
APIUserID {GUID – 16 bytes}
Your API User ID, from your Profile page

APIKey {string}

Your API secret key, from your Profile page

Returns

WebAPIResult

The AuthHeader will be contained in the Details string if successful. Check Status before using the Details.


ProcessSale

Marks a sale of a particular item to have occurred, and queues it up for processing by ComicBase. The user’s local database will see any pending transactions and be able to record the sales/roll the items out of inventory when they use ComicBase’s Internet > Check for Sales and Purchases (or do that check with ComicBase Sidekick)

Note: The user ID corresponding to the API credentials will be used as the designee for the sale. It is not possible to post a sale as belonging to a database other than your own.

Must contain a valid authorization header (see GetAuthHeader). Will return 404 (not found) if the auth header is invalid or expired.

https://comicbase.com/api/ProcessSale

POST with a CBAPISale record in the request body

Returns

WebAPIResult


AddSalesAdjustment

Allows you to post an adjustment to an existing sale, to reflect price changes, condition changes, item cancellations, etc. This will be downloaded and adjustments made to the user’s local sales table when they use ComicBase’s Internet > Check for Sales and Purchases command (or do so from ComicBase Sidekick).

This call will fail if the specified OrderID has not been used for an order previously recorded for the given user on the specified SalesVenue.

Must contain a valid authorization header (see GetAuthHeader). Will return 404 (not found) if the auth header is invalid or expired.

https://comicbase.com/api/AddSalesAdjustment

POST with a CBAPISalesAdjustment record in the request body

Returns

WebAPIResult

Categories: