データAPI

データAPI #

この章では、Commerbleの提供するWeb APIのうちデータAPIについて説明します。

データAPIでは、Commerbleに保存されているデータにアクセスすることができます。

また、アクセスするデータによって以下の3つのエンドポイントに分かれています。

  • EC Feed
  • CMS Feed
  • Meta Feed

データAPIは全て ODataとして提供されます。 ODataの仕様は、 OData V4 Documentationもしくは OData V3 Documentationをご確認ください。

EC Feed #

EC Feedでは、共通スキーマの情報を作成、更新、削除できます。 操作可能なデータはODataメタデータを確認ください。

エンドポイントメタデータ補足
~/data/ec~/data/ec/$metadata現行エンドポイント、OData V4
~/ec.feed.v5/odata.svc~/ec.feed.v5/odata.svc/$metadata旧エンドポイント、OData V3

またメタデータに合わせて、 データ:ECデータもご確認ください。

CMS Feed #

CMS Feedでは、テナントごとにカスタムされたスキーマの情報を作成、更新、削除できます。

はじめに、使用するCMSスキーマを策定する必要があります。詳しくは、 CMSスキーマの定義例をご確認ください。

スキーマの定義を作成後、オーダーカスタムをご依頼いただきCommerble社側でスキーマを反映いたします。 反映までが完了しない状態でメタデータにアクセスしても操作可能なデータが無いことに留意が必要です。

CMSスキーマの反映後は、操作可能なデータはODataメタデータを確認ください。

エンドポイントメタデータ補足
~/data/cms~/data/cms/$metadata現行エンドポイント、OData V4
~/cms.feed.v2/list/odata.svc~/cms.feed.v2/list/odata.svc/$metadata旧エンドポイント、OData V3

Meta Feed #

Meta Feedでは、テンプレートやルーティングなどのCMS機能にかかわる共通スキーマ情報を作成、更新、削除できます。操作可能なデータはODataメタデータを確認ください。

エンドポイントメタデータ補足
~/data/meta~/data/meta/$metadata現行エンドポイント、OData V4
~/cms.feed.v2/metadata/odata.svc~/cms.feed.v2/metadata/odata.svc/$metadata旧エンドポイント、OData V3

またメタデータに合わせて、 データ:メタデータもご確認ください。

サンプル #

以下にEC Feedで商品を追加する例を示します。

--- リクエスト ---
POST ~/data/ec/Products HTTP/1.1
Accept: application/json
Authorization: Basic xxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
  "Name": "サンプル商品1-黒-S",
  "ProductType": 0,
  "SalesStart": "2020-01-01T00:00:00+09:00",
  "SalesEnd": null,
  "ReleaseDate": null,
  "ReReleaseDate": null,
  "ExternalId1": "SAMPLE001",
  "ExternalId2": "BLK-S",
  "ExternalId3": null,
  "ExternalId4": null,
  "UnitPrice": 1000,
  "TaxationPrice": 1000,
  "SalesPatternId": 1,
  "DeliveryPatternId": 1,
  "SalesStatus": 0
}

--- レスポンス ---
HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Length: 519
Content-Type: application/json;charset=utf-8
Location: ~/data/ec/Products(1)

{
    "@odata.context": "~/data/ec/$metadata#Products/$entity",
    "Id": 1,
    "Name": "サンプル商品1-黒-S",
    "ProductType": 0,
    "SalesStart": "2020-01-01T00:00:00+09:00",
    "SalesEnd": null,
    "ReleaseDate": null,
    "ReReleaseDate": null,
    "ExternalId1": "SAMPLE001",
    "ExternalId2": "BLK-S",
    "ExternalId3": null,
    "ExternalId4": null,
    "UnitPrice": 1000,
    "SalesPatternId": 1,
    "DeliveryPatternId": 1,
    "SetOnly": null,
    "Cero": null,
    "MemoId": null,
    "SalesStatus": 0,
    "TaxationPrice": 1000,
    "OrderedProduct": null
}