受注関連のAPIの仕様を変更します

2023/02/16

こちらの仕様変更は4月17日に行いました。（2023/04/17追記）

受注関連のAPIの仕様変更について

カラーミーショップでは2023年4月17日に、「受注区分設定※」の提供を予定しています。
※提供予定日を延期しました。日程については、このお知らせにて再度ご連絡します。
※機能名が「受注分割機能」から「受注区分設定」に変更となりました。

今回のリリースに際して、受注関連のAPIの仕様が以下のように変更になります。
受注区分設定を利用した場合に、これまでの挙動と異なる場合がございます。

これに伴い、ショップオーナーさまよりご提供中のアプリに関するお問い合わせが届く場合があります。
恐れ入りますが、下記「受注関連APIの仕様」をご参考のうえ、各社様にて仕様の確認およびご対応をお願いいたします。

2023/03/31追記
スクリプトタグ用カラーミーショップオブジェクトにおいても、取得できる情報を変更する予定です。
詳細はスクリプトタグ用カラーミーショップオブジェクト（購入完了後のsale）の仕様を変更しますをご確認してください。

受注区分設定とは

受注区分設定とは、1回で注文された受注をあらかじめ登録されたグループに沿って自動で分割できるようになる機能です。通常配送とクール便を分けて受注をとる、配送時期の異なる商品を同じ注文として受注を取る、といった利用を想定しています。

受注区分設定の提供を予定しています

受注関連APIの仕様

受注データのリスト(v1/sales)

該当受注が分割されている受注かどうか判断できるようになります
割引金額の総額が個別の分割された受注より大きい場合、マイナスの受注金額が照会されます
受注に区分がついている場合には segment という項目に対し、以下の情報が付与されます
- name
  - 区分名
- parent_sale_id
  - 親受注の受注ID
- total_price
  - 分割された受注金額の総計
- splitted
  - 受注が分割されているかどうか
  - true または false

レスポンス例

{
  "sales": [
    // 受注区分がついていて、分割されている受注
    // 親受注
    {
      "id": 1,
      /** 他の項目については省略**/
      "segment": {
        "name": "区分名",
        "parent_sale_id": 1,
        "splitted": true,
        "total_price": 1000
      }
    },
    // 受注区分がついていて、分割されている受注
    // 子受注
    {
      "id": 2,
      /** 他の項目については省略**/
      "segment": {
        "name": "区分名2",
        "parent_sale_id": 1, // 受注が分割されている場合、親受注の ID を返します
        "splitted": true,
        "total_price": 1000
      }
    },
    // 受注に区分ついていて、分割されていない受注
    {
      "id": 3,
      /** 他の項目については省略**/
      "segment": {
        "name": "区分名2",
        "parent_sale_id": 3, // 分割されていない場合自身の 受注ID を返します
        "splitted": false,
        "total_price": 1000
      }
    }
    // 通常の受注
    {
      "id": 4,
      /** 他の項目については省略**/
      "segment": null
    }
    ,
  ],
  "meta": {
    "total": 300,
    "limit": 50,
    "offset": 200
  }
}

受注データの取得(v1/sales/{sale_id})

該当受注が分割されている受注かどうか判断できるようになります
割引金額の総額が個別の分割された受注より大きい場合、マイナスの受注金額が照会されます
受注に区分がついている場合には segment という項目に対し、以下の情報が付与されます
- name
  - 区分名
- parent_sale_id
  - 親受注の受注ID
- splitted
  - 受注が分割されているかどうか
  - true または false
- total_price
  - 分割された受注金額の総計
- siblings_sale_ids
  - 分割された受注ID

レスポンス例

{
  "sale": {
    "id": 2,
    /** 他の項目については省略**/
    "segment": {
      "name": "区分名",
      "parent_sale_id": 1,
      "splitted": true,
      "total_price": 1000,
      "siblings_sale_ids": [1,2]
    }
  }
}

受注データの更新(v1/sales/{sale_id})

対象が分割された受注の場合、親受注のみポイントのステータスが更新できます

受注データのキャンセル(v1/sales/{sale_id}/cancel)

親受注をキャンセルすると分割されている他の受注もキャンセルされます
子受注を指定した場合、エラーのレスポンスを返します

受注・入金確認・商品発送メール(v1/sales/{sale_id}/mails)

受注メール
- 親受注を指定した場合、全ての受注情報が含まれたメールが送信されます
- 子受注を指定した場合、エラーのレスポンスを返します
入金確認メール
- 親受注を指定した場合、全ての受注情報が含まれたメールが送信されます
- 子受注を指定した場合、エラーのレスポンスを返します

デザイン変更について

一部軽微なデザイン変更を予定しています。

変更該当箇所

メール
受注一覧
受注詳細
商品検索
商品登録
受注管理（未処理分）
カート内表示（カート・入力画面・確認画面）
納品書
請求書
受注伝票

受注管理

受注詳細

メール画面

配送予定日の追加


【　受　注　番　号　】671442935,671442936
▼お客様情報
================================
【　お　　名　　前　】山田　太郎 様
【　法人名・会社名　】
【　部　　署　　名　】
【　メールアドレス　】mail@example.com
【　郵　便　番　号　】1508512
【　ご　　住　　所　】東京都渋谷区桜丘町　
【　電　話　番　号　】08000123456
【　メールマガジン　】受信する
【 フリー項目1です  】
【 フリー項目2です  】
【 フリー項目3です  】
【　注　　文　　日　】2022/12/19
【　決　済　方　法　】商品代引き（ゆうパック・ゆうメール）
================================
▼配送先情報
================================
［ 通　常（売上ID:671442935）］
--------------------------------
【　お　　名　　前　】山田　太郎 様
【　郵　便　番　号　】1508512
【　ご　　住　　所　】東京都渋谷区桜丘町　
【　電　話　番　号　】08000123456
【　ギフトサービス　】希望しない
【　配　送　会　社　】無料配送
--------------------------------
［　商　品　詳　細　］
--------------------------------
【　商　品　Ｉ　Ｄ　】6
【　商　品　番　号　】
【　商　　品　　名　】予約うさぎ
【配　送　予　定　日】2023/01/10
【　価　格　(税込)　】242円
【　　税　　　率　　】10%
【　　数　　　量　　】1
【　　小　　　計　　】242円
--------------------------------
［配　送　先　合　計］
--------------------------------
【　　送　　　料　　】0円（税込）
【配　送　先　合　計】242円（税込）
================================
［ クール便（売上ID:671442936）］
--------------------------------
【　お　　名　　前　】山田　太郎 様
【　郵　便　番　号　】1508512
【　ご　　住　　所　】東京都渋谷区桜丘町　
【　電　話　番　号　】08000123456
【　ギフトサービス　】利用不可
【　お届け　希望日　】希望しない
【お届け希望　時間帯】希望しない
【　配　送　会　社　】佐川急便
--------------------------------
［　商　品　詳　細　］
--------------------------------
【　商　品　Ｉ　Ｄ　】4
【　商　品　番　号　】
【　商　　品　　名　】毛ガニ
【　価　格　(税込)　】220円
【　　税　　　率　　】10%
【　　数　　　量　　】1
【　　小　　　計　　】220円
--------------------------------
［配　送　先　合　計］
--------------------------------
【　　送　　　料　　】1,000円（税込）
【配　送　先　合　計】1,220円（税込）
================================
▼総合計
================================
【　合計（消費税）　】462円(42円)
【　10％対象　合計　】462円
【　 8％対象　合計　】0円
【　送　料　合　計　】1,000円（税込）
【決　済　手　数　料】300円（税込）
--------------------------------
【当店のポイント割引】0円
--------------------------------
【　総　　合　　計　】1,762円
================================

更新履歴

2023/03/03
- リリース日の変更に伴い、内容を訂正
- 機能名を変更
2023/03/31
- リリース日を追記
- スクリプトタグ用カラーミーショップオブジェクトに関する情報を追記
2023/04/06
- 参照系のAPIのレスポンスに受注の合計金額を追加
2023/04/17
- 提供開始日を追記