STORES Retail API

https://heyinc.github.io/retail-api-docs/
Admin
STORES Retail API provides endpoints to integrate and manage orders, items, categories, coupons, and...
Tokens:13,222
Snippets:55
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Retrieve Items List Response Structure

Source: https://heyinc.github.io/retail-api-docs/202211.html

Example JSON response body returned by the GET /retail/202211/items endpoint.

```json
{
  "items": [
    {
      "id": "616950cd768f7263b4dab1a1",
      "name": "Tシャツ",
      "created_at": "2021-12-09T12:30:00+09:00",
      "status": "shown",
      "image_urls": [
        "https://example.com/images/1",
        "https://example.com/images/2",
        "https://example.com/images/3"
      ],
      "limited_quantity": 0,
      "description": "オリジナルのTシャツです。",
      "reduced_tax": false,
      "type": "regular",
      "price": 900,
      "regular_price": 1000,
      "discount_amount": 3,
      "discount_rate": 0.1,
      "category_ids": [
        "6fe0533a768f726223c76f71"
      ],
      "delivery_method_ids": {
        "domestic": "616950cd768f7263b4dab1a1"
      },
      "preorder_sales": {
        "start_month": "202112",
        "end_month": "202201",
        "start_period": "early",
        "end_period": "late"
      },
      "sales_period": {
        "period_start_at": "2021-12-09T12:30:00+09:00",
        "period_end_at": "2022-01-10T12:30:00+09:00"
      },
      "variations": [
        {
          "id": "5fe0533a768f726223c76f70",
          "name": "S",
          "quantity": null,
          "code": "1",
          "barcode": null,
          "sales_price": 900,
          "regular_price": 1000,
          "discount_amount": 100,
          "discount_rate": 0.1
        },
        {
          "id": "5fe0533a768f726223c76f71",
          "name": "M",
          "quantity": 20,
          "code": "2",
          "barcode": "4912345678904",
          "sales_price": 900,
          "regular_price": 1000,
          "discount_amount": 100,
          "discount_rate": 0.1
        },
        {
          "id": "600a3c13768f72b2a6baabea",
          "name": "L",
          "quantity": 10,
          "code": "3",
          "barcode": null,
          "sales_price": 900,
          "regular_price": 1000,
          "discount_amount": 100,
          "discount_rate": 0.1
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /retail/202211/store

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves information about the store.

```APIDOC
## GET /retail/202211/store

### Description
Returns the store information.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/store

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the store.
- **name** (string) - The name of the store.

#### Response Example
{
  "id": "66a0ba9ed7785100a418d4f9",
  "name": "STORES SHOP"
}
```

--------------------------------

### GET /retail/202211/orders

Source: https://heyinc.github.io/retail-api-docs/202211.html

オーダーの一覧をオーダーされた日時の降順で取得します。様々な検索条件を指定してフィルタリングが可能です。

```APIDOC
## GET /retail/202211/orders

### Description
オーダーの一覧をオーダーされた日時の降順で返します。実際のオーダー日時からこのAPIに出力されるまでに時間がかかる場合があります。

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/orders

### Parameters
#### Query Parameters
- **ids** (string) - Optional - オーダー ID で検索する場合に指定してください。複数指定する場合はカンマ(,)区切り。
- **numbers** (string) - Optional - オーダー番号で検索する場合に指定してください。複数指定する場合はカンマ(,)区切り。
- **settled_sales_channel** (string) - Optional - オーダーを決済された店舗で検索したい場合に指定してください。
- **ordered_at_from** (string) - Optional - 特定の日時以降のオーダーを検索したい場合に指定してください。
- **ordered_at_to** (string) - Optional - 特定の日時以前のオーダーを検索したい場合に指定してください。
- **canceled_at_from** (string) - Optional - 特定の日時以降にキャンセルまたは返金されたオーダーを検索したい場合に指定してください。
- **canceled_at_to** (string) - Optional - 特定の日時以前にキャンセルまたは返金されたオーダーを検索したい場合に指定してください。
- **readied_at_from** (string) - Optional - 特定の日時以降の readied_at でオーダーを検索したい場合に指定してください。
- **readied_at_to** (string) - Optional - 特定の日時以前の readied_at でオーダーを検索したい場合に指定してください。
- **delivery_start_date_from** (string) - Optional - 配送日指定の最短配送希望日、予約販売の発送開始予定時期で検索したい場合に指定してください。
- **delivery_start_date_to** (string) - Optional - 配送日指定の最短配送希望日、予約販売の発送開始予定時期で検索したい場合に指定してください。
- **paid_status** (string) - Optional - 決済のステータスを指定してください (paid, unpaid)。
- **delivery_status** (string) - Optional - 配送のステータスを指定してください (shipped, waiting)。
- **direction** (string) - Optional - オーダー日時による並べ替えの方向を指定します (desc, asc)。
- **limit** (integer) - Optional - 取得するデータの最大件数 (1-100)。
- **offset** (integer) - Optional - 取得をスキップする件数。

### Response
#### Success Response (200)
- **200** - 成功
```

--------------------------------

### Retrieve Categories Response

Source: https://heyinc.github.io/retail-api-docs/202211.html

Example JSON response for the category list endpoint.

```json
{
  "categories": [
    {
      "id": "61d69d81cb64675b2da8a2c7",
      "created_at": "2021-12-09T12:30:00+09:00",
      "name": "インテリア",
      "parent_id": "61d69d8dcb64675b2da8a2c8"
    }
  ]
}
```

--------------------------------

### Inventory Adjustment Response

Source: https://heyinc.github.io/retail-api-docs/202211.html

Example response structure for a successful inventory adjustment request.

```json
{
  * "variation_id": "616950cd768f7263b4dab1a1",
  * "quantity": 10

}
```

--------------------------------

### GET /retail/202211/shipping_fee_settings

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves domestic and international shipping fee settings.

```APIDOC
## GET /retail/202211/shipping_fee_settings

### Description
Retrieves domestic and international shipping fee settings.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/shipping_fee_settings
```

--------------------------------

### Retrieve Remittance List Response

Source: https://heyinc.github.io/retail-api-docs/202211.html

Example response containing a list of remittance records.

```json
{
  * "remittances": [
    * {
      * "id": "62e2591363eb58003fd5c2ea",
      * "transferred_date": "2022-06-30",
      * "transfer_amount": 16595,
      * "transfer_fee": 275,
      * "sales_amount": 17500,
      * "payment_fee": 630,
      * "speedcash_payment_fee": 0,
      * "used_speedcash": false,
      * "chargeback_amount": 0,
      * "deduction_amount": 0,
      * "campaign_coupon_fee": 0
}
]

}
```

--------------------------------

### GET /retail/202211/categories

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves a list of categories in the configured order.

```APIDOC
## GET /retail/202211/categories

### Description
Retrieves a list of categories in the configured order.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/categories

### Parameters
#### Query Parameters
- **ids** (string) - Optional - Category IDs to search for. Multiple IDs can be specified separated by commas.
- **parent_ids** (string) - Optional - Parent category IDs to search for. Multiple IDs can be specified separated by commas.
- **limit** (integer) - Optional - Maximum number of items to retrieve (1-100, default: 10).
- **offset** (integer) - Optional - Number of items to skip (default: 0).

### Response
#### Success Response (200)
- **categories** (array) - List of category objects.
```

--------------------------------

### GET /retail/202211/sales_channels

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves a list of sales channels, ordered by registration date in descending order.

```APIDOC
## GET /retail/202211/sales_channels

### Description
Retrieves a list of sales channels, ordered by registration date in descending order.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/sales_channels

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Maximum number of items to retrieve (1-100, default: 10).
- **offset** (integer) - Optional - Number of items to skip (default: 0).

### Response
#### Success Response (200)
- **sales_channels** (array) - List of sales channel objects.

#### Response Example
{
  "sales_channels": [
    {
      "id": "jiahoiranbhoiaasoxx",
      "name": "○×店",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### GET /retail/202211/items

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves a list of items based on the order set in the dashboard. Note that store inventory counts are not included.

```APIDOC
## GET /retail/202211/items

### Description
Retrieves a list of items based on the order set in the dashboard. Note that store inventory counts are not included.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/items

### Parameters
#### Query Parameters
- **ids** (string) - Optional - Item IDs to search for, comma-separated.
- **status** (string) - Optional - Item status: "shown", "hidden", or "unlisted".
- **in_stock** (boolean) - Optional - Filter by stock availability.
- **only_preorder_sales** (boolean) - Optional - Filter for preorder items only. Default: false.
- **keyword** (string) - Optional - Partial match search for name, description, barcode, or product code. Max 100 characters.
- **limit** (integer) - Optional - Max number of items to return (1-100). Default: 10.
- **offset** (integer) - Optional - Number of items to skip. Default: 0.

### Response
#### Success Response (200)
- **items** (array) - List of item objects.

#### Response Example
{
  "items": [
    {
      "id": "616950cd768f7263b4dab1a1",
      "name": "Tシャツ",
      "status": "shown",
      "price": 900
    }
  ]
}
```

--------------------------------

### GET /retail/202211/remittances

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves a list of remittance information sorted by transfer date in descending order.

```APIDOC
## GET /retail/202211/remittances

### Description
Retrieves a list of remittance information sorted by transfer date in descending order. Only completed remittance data is returned.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/remittances

### Parameters
#### Query Parameters
- **ids** (string) - Optional - idで検索する場合に指定してください
- **transferred_date_from** (string) - Optional - 特定の振込日以降のオーダーを検索 (YYYY-MM-DD)
- **transferred_date_to** (string) - Optional - 特定の振込日以前のオーダーを検索 (YYYY-MM-DD)
- **limit** (integer) - Optional - 取得するデータの最大件数 (1-100, Default: 10)
- **offset** (integer) - Optional - 取得をスキップする件数 (Default: 0)

### Response
#### Success Response (200)
- **remittances** (array) - List of remittance objects

#### Response Example
{
  "remittances": [
    {
      "id": "62e2591363eb58003fd5c2ea",
      "transferred_date": "2022-06-30",
      "transfer_amount": 16595,
      "transfer_fee": 275,
      "sales_amount": 17500,
      "payment_fee": 630,
      "speedcash_payment_fee": 0,
      "used_speedcash": false,
      "chargeback_amount": 0,
      "deduction_amount": 0,
      "campaign_coupon_fee": 0
    }
  ]
}
```

--------------------------------

### GET /retail/202211/remittances/{remittance_id}/order_ids

Source: https://heyinc.github.io/retail-api-docs/202211.html

Retrieves a list of order IDs associated with a specific remittance ID.

```APIDOC
## GET /retail/202211/remittances/{remittance_id}/order_ids

### Description
Retrieves a list of order IDs associated with a specific remittance ID.

### Method
GET

### Endpoint
https://api.stores.dev/retail/202211/remittances/{remittance_id}/order_ids

### Parameters
#### Path Parameters
- **remittance_id** (string) - Required - The ID of the remittance.

### Response
#### Success Response (200)
- **remittance_id** (string) - The remittance ID.
- **order_ids** (array) - List of order IDs.

#### Response Example
{
  "remittance_id": "string",
  "order_ids": ["string"]
}
```

--------------------------------

### List Sales Channels

Source: https://heyinc.github.io/retail-api-docs/202211.html

Returns a list of store information sorted by registration date in descending order.

```json
{
  "sales_channels": [
    {
      "id": "jiahoiranbhoiaasoxx",
      "name": "○×店",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
```

--------------------------------

### Order JSON Response Sample

Source: https://heyinc.github.io/retail-api-docs/202211.html

A sample JSON object representing an order, containing fields for sales amounts, tax details, payment transactions, and delivery items.

```json
{
  "orders": [
    {
      "id": "624ec8c2768f72913ffe9694",
      "number": "6187637539",
      "sales_channel_id": "6074246c768f720a0edcfd4e",
      "email": null,
      "sales_amount": 2900,
      "sales_discount": 400,
      "cancel_amount": 0,
      "cancel_discount": 0,
      "sales_tax": 263,
      "cancel_tax": 0,
      "tax_details": [
        {
          "tax_class": "taxable",
          "tax_rate": 0.1,
          "sales_tax": 263,
          "cancel_tax": 0,
          "sales_amount": 2900,
          "sales_discount": 400,
          "cancel_amount": 0,
          "cancel_discount": 0
        }
      ],
      "payment_amount": 2900,
      "payment_tax": 263,
      "transactions": [
        {
          "id": "624fa1ac768f72913ffe969a",
          "type": "custom",
          "payment_method_name": "商品券",
          "sales_channel_id": "6074246c768f720a0edcfd4e",
          "amount": 2000,
          "deposit": 2000,
          "change": 0,
          "paid_at": "2022-04-08T11:45:00+09:00",
          "payment_fee": 0,
          "payment_fee_rate": 0,
          "fee": null,
          "system_fee": null
        },
        {
          "id": "624fa2a3768f72913ffe969c",
          "type": "cash",
          "sales_channel_id": "6074246c768f720a0edcfd4e",
          "amount": 900,
          "deposit": 1000,
          "change": 100,
          "paid_at": "2022-04-08T11:45:30+09:00",
          "payment_fee": 0,
          "payment_fee_rate": 0,
          "fee": null,
          "system_fee": null
        }
      ],
      "deliveries": [
        {
          "id": "624ec8c3768f72913ffe9696",
          "type": "counter",
          "items": [
            {
              "id": "624ec8c3768f72913ffe9697",
              "type": "regular",
              "name": "Tシャツ",
              "item_id": "60370f63768f721041d91a0c",
              "variation_id": "60370f63768f721041d91a10",
              "variation_name": "Mサイズ",
              "code": null,
              "barcode": "4912345123459",
              "tax_rate": 0.1,
              "regular_price": 3300,
              "quantity": 1,
              "option": [
                {
                  "id": "624ec8c3768f72913ffe9699",
                  "name": "¥100引き",
                  "price": -100,
                  "quantity": 1
                }
              ]
            }
          ],
          "canceled_at": null,
          "shipped_at": "2022-04-08T11:55:19+09:00"
        }
      ],
      "option": [
        {
          "id": "624ec8c3768f72913ffe9695",
          "type": "amount_discount",
          "name": "¥300引き",
          "price": -300
        }
      ],
      "note": "オーダーのメモ",
      "remarks": "",
      "receipt_address": null,
      "ordered_at": "2022-04-07T20:19:31+09:00",
      "readied_at": "2022-04-08T11:45:00+09:00",
      "billing_address": {
        "first_name": "太郎",
        "last_name": "田中",
        "tel": "00000000000",
        "zip_code": "1500011",
        "country": "日本",
        "prefecture": "東京都",
        "address": "渋谷区東3丁目16番3号"
      }
    }
  ]
}
```

--------------------------------

### POST /retail/202211/items

Source: https://heyinc.github.io/retail-api-docs/202211.html

指定した内容でアイテムを登録します。物販のアイテムのみ作成可能です。

```APIDOC
## POST https://api.stores.dev/retail/202211/items

### Description
指定した内容でアイテムを登録します。物販のアイテムのみ作成可能です。

### Method
POST

### Endpoint
https://api.stores.dev/retail/202211/items

### Parameters
#### Request Body
- **name** (string) - Required - アイテム名
- **description** (string) - Required - 商品説明
- **images** (Array of strings) - Optional - アップロードした画像のファイル名
- **category_ids** (Array of strings) - Optional - カテゴリーID
- **reduced_tax** (boolean) - Optional - 軽減税率対象か否か
- **delivery_method_ids** (object) - Optional - 配送方法
- **status** (string) - Required - ステータス ("shown", "hidden")
- **limited_quantity** (integer) - Optional - 個数制限
- **type** (string) - Required - アイテムの種類 ("regular")
- **variations** (Array of objects) - Required - バリエーション
- **sales_period** (object or null) - Optional - 販売期間情報
- **preorder_sales** (object or null) - Optional - 予約販売情報

### Request Example
{
  "name": "Tシャツ",
  "description": "オリジナルのTシャツです。",
  "images": ["08cf3dc613365347f68b.jpeg"],
  "category_ids": ["a123456", "b2345676"],
  "reduced_tax": false,
  "delivery_method_ids": {"domestic": "616950cd768f7263b4dab1a1"},
  "status": "shown",
  "limited_quantity": 0,
  "type": "regular",
  "variations": [
    {"name": "S", "quantity": 0, "code": "1", "barcode": "4912345678904", "regular_price": 1000, "discount_rate": 0.1},
    {"name": "M", "quantity": 20, "code": "2", "barcode": "4912345678904", "regular_price": 1000, "discount_rate": 0.1},
    {"name": "L", "quantity": 10, "code": "3", "barcode": null, "regular_price": 1000, "discount_rate": 0.1}
  ],
  "sales_period": {"period_start_at": "2021-12-09T12:30:00", "period_end_at": "2022-01-10T12:30:00"},
  "preorder_sales": {"start_month": "2021-12", "end_month": "2022-01", "start_period": "early", "end_period": "late"}
}

### Response
#### Success Response (201)
- **id** (string) - アイテムID
- **name** (string) - アイテム名
- **status** (string) - ステータス

#### Response Example
{
  "id": "616950cd768f7263b4dab1a1",
  "name": "Tシャツ",
  "status": "shown"
}
```

--------------------------------

### 配送情報更新リクエストペイロード

Source: https://heyinc.github.io/retail-api-docs/202211.html

配送情報を更新する際に送信するJSON形式のデータ構造です。

```json
{
  "delivery_method_name": "string",
  "estimated_arrival_date": "2019-08-24T14:15:22Z",
  "tracking_number": "012030485",
  "shipped_mail_message": "配送情報メモ"
}
```

--------------------------------

### アイテム作成レスポンスサンプル

Source: https://heyinc.github.io/retail-api-docs/202211.html

アイテム作成成功時のレスポンス例です。登録されたアイテムのIDや詳細情報が含まれます。

```json
{
  "id": "616950cd768f7263b4dab1a1",
  "name": "Tシャツ",
  "created_at": "2021-12-09T12:30:00+09:00",
  "status": "shown",
  "image_urls": [
    "https://example.com/images/1",
    "https://example.com/images/2",
    "https://example.com/images/3"
],
  "limited_quantity": 0,
  "description": "オリジナルのTシャツです。",
  "reduced_tax": false,
  "type": "regular",
  "preorder_sales": {
    "start_month": "202112",
    "end_month": "202201",
    "start_period": "early",
    "end_period": "late"
},
  "sales_period": {
    "period_start_at": "2021-12-09T12:30:00+09:00",
    "period_end_at": "2022-01-10T12:30:00+09:00"
},
  "variations": [
    {
      "id": "5fe0533a768f726223c76f70",
      "name": "S",
      "quantity": null,
      "code": "1",
      "barcode": null,
      "price": 900,
      "sales_price": 900,
      "regular_price": 1000,
      "discount_amount": 100,
      "discount_rate": 0.1
},
    {
      "id": "5fe0533a768f726223c76f71",
      "name": "M",
      "quantity": 20,
      "code": "2",
      "barcode": "4912345678904",
      "price": 900,
      "sales_price": 900,
      "regular_price": 1000,
      "discount_amount": 100,
      "discount_rate": 0.1
},
    {
      "id": "600a3c13768f72b2a6baabea",
      "name": "L",
      "quantity": 10,
      "code": "3",
      "barcode": null,
      "price": 900,
      "sales_price": 900,
      "regular_price": 1000,
      "discount_amount": 100,
      "discount_rate": 0.1
}
],
  "price": 1800,
  "regular_price": 2000,
  "discount_amount": 200,
  "discount_rate": 0.1,
  "category_ids": [
    "5fe0533a768f726223c76f70"
],
  "delivery_method_ids": {
    "domestic": "5fe0533a768f726223c76f70"
}

}
```

--------------------------------

### アイテム作成リクエストサンプル

Source: https://heyinc.github.io/retail-api-docs/202211.html

アイテム作成APIへのPOSTリクエストボディの例です。バリエーションや販売期間、予約販売情報を含めることができます。

```json
{
  "name": "Tシャツ",
  "description": "オリジナルのTシャツです。",
  "images": [
    "08cf3dc613365347f68b.jpeg"
],
  "category_ids": [
    "a123456",
    "b2345676"
],
  "reduced_tax": false,
  "delivery_method_ids": {
    "domestic": "616950cd768f7263b4dab1a1"
},
  "status": "shown",
  "limited_quantity": 0,
  "type": "regular",
  "variations": [
    {
      "name": "S",
      "quantity": 0,
      "code": "1",
      "barcode": "4912345678904",
      "regular_price": 1000,
      "discount_rate": 0.1
},
    {
      "name": "M",
      "quantity": 20,
      "code": "2",
      "barcode": "4912345678904",
      "regular_price": 1000,
      "discount_rate": 0.1
},
    {
      "name": "L",
      "quantity": 10,
      "code": "3",
      "barcode": null,
      "regular_price": 1000,
      "discount_rate": 0.1
}
],
  "sales_period": {
    "period_start_at": "2021-12-09T12:30:00",
    "period_end_at": "2022-01-10T12:30:00"
},
  "preorder_sales": {
    "start_month": "2021-12",
    "end_month": "2022-01",
    "start_period": "early",
    "end_period": "late"
}

}
```

--------------------------------

### POST /retail/202211/coupons

Source: https://heyinc.github.io/retail-api-docs/202211.html

Creates a new coupon with the specified details.

```APIDOC
## POST /retail/202211/coupons

### Description
Creates a new coupon based on the provided configuration.

### Method
POST

### Endpoint
https://api.stores.dev/retail/202211/coupons

### Parameters
#### Request Body
- **name** (string) - Required - Coupon name (1-20 characters)
- **code** (string/null) - Required - Coupon code (1-10 characters). Set to null if auto_code_generation is true.
- **auto_code_generation** (boolean) - Required - Whether to auto-generate the coupon code.
- **status** (boolean) - Required - Coupon status (true for active, false for inactive).
- **quantity** (integer/null) - Required - Number of coupons to issue. Use null for unlimited.
- **mail_notice** (boolean) - Required - Whether to send automated emails near the start and end dates.
- **frequency_limitation** (integer) - Required - Usage limit (0: unlimited, 1: once per person).
- **details** (Array) - Required - Coupon type and discount settings.
- **conditions** (Array) - Required - Usage conditions.
- **expire** (object/null) - Required - Expiration settings. Use null for no expiration.

### Request Example
{
  "name": "割引クーポン",
  "code": "pL8PWJ21vH",
  "auto_code_generation": false,
  "status": true,
  "quantity": null,
  "mail_notice": true,
  "frequency_limitation": 0,
  "details": [
    {
      "type": "free_shipping"
    }
  ],
  "conditions": [
    {
      "type": "amount",
      "value": 1000
    }
  ],
  "expire": {
    "start_date": "2023-08-01",
    "start_hour": 0,
    "start_minute": 0,
    "end_date": "2023-08-31",
    "end_hour": 23,
    "end_minute": 59
  }
}

### Response
#### Success Response (201)
- **id** (string) - Created coupon ID
- **name** (string) - Coupon name
- **code** (string) - Coupon code
- **status** (boolean) - Coupon status
- **quantity** (integer/null) - Issued quantity
- **mail_notice** (boolean) - Email notice setting
- **frequency_limitation** (integer) - Usage limit
- **details** (Array) - Coupon details
- **conditions** (Array) - Usage conditions
- **expire** (object) - Expiration settings
- **created_at** (string) - Creation timestamp

#### Response Example
{
  "id": "616950cd768f7263b4dab1a1",
  "name": "割引クーポン",
  "code": "pL8PWJ21vH",
  "status": true,
  "quantity": null,
  "mail_notice": true,
  "frequency_limitation": 0,
  "details": [
    {
      "type": "free_shipping",
      "value": null
    }
  ],
  "conditions": [
    {
      "type": "amount",
      "value": 1000
    }
  ],
  "expire": {
    "start_date": "2023-08-01",
    "start_hour": 0,
    "start_minute": 0,
    "end_date": "2023-08-31",
    "end_hour": 23,
    "end_minute": 59
  },
  "created_at": "2023-07-24T14:15:22Z"
}
```

--------------------------------

### クーポン作成リクエストサンプル

Source: https://heyinc.github.io/retail-api-docs/202211.html

クーポン作成時に送信するJSONペイロードの例です。auto_code_generationがfalseの場合、codeフィールドに値を指定する必要があります。

```json
{
  "name": "割引クーポン",
  "code": "pL8PWJ21vH",
  "auto_code_generation": false,
  "status": true,
  "quantity": null,
  "mail_notice": true,
  "frequency_limitation": 0,
  "details": [
    {
      "type": "free_shipping"
    }
  ],
  "conditions": [
    {
      "type": "amount",
      "value": 1000
    }
  ],
  "expire": {
    "start_date": "2023-08-01",
    "start_hour": 0,
    "start_minute": 0,
    "end_date": "2023-08-31",
    "end_hour": 23,
    "end_minute": 59
  }
}
```

--------------------------------

### クーポン作成レスポンスサンプル

Source: https://heyinc.github.io/retail-api-docs/202211.html

クーポン作成成功時(201 Created)に返されるレスポンスの例です。生成されたクーポンのIDと作成日時が含まれます。

```json
{
  "id": "616950cd768f7263b4dab1a1",
  "name": "割引クーポン",
  "code": "pL8PWJ21vH",
  "status": true,
  "quantity": null,
  "mail_notice": true,
  "frequency_limitation": 0,
  "details": [
    {
      "type": "free_shipping",
      "value": null
    }
  ],
  "conditions": [
    {
      "type": "amount",
      "value": 1000
    }
  ],
  "expire": {
    "start_date": "2023-08-01",
    "start_hour": 0,
    "start_minute": 0,
    "end_date": "2023-08-31",
    "end_hour": 23,
    "end_minute": 59
  },
  "created_at": "2023-07-24T14:15:22Z"
}
```

--------------------------------

### Retrieve Store Information

Source: https://heyinc.github.io/retail-api-docs/202211.html

Endpoint for fetching store details. Returns a JSON object containing the store ID and name.

```json
{
  "id": "66a0ba9ed7785100a418d4f9",
  "name": "STORES SHOP"
}
```

--------------------------------

### Image Upload Success Response

Source: https://heyinc.github.io/retail-api-docs/202211.html

XML response received after a successful image upload to the storage bucket.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<PostResponse>
  <Location>https://xxxxxxxxxx/08cf3dc613365347f68b.jpeg</Location>
  <Bucket>xxxxxx</Bucket>
  <Key>08cf3dc613365347f68b.jpeg</Key>
  <ETag>"1f402d516612df43e3668bba5e34ac58"</ETag>
</PostResponse>
```

--------------------------------

### POST /retail/202211/items/image_upload

Source: https://heyinc.github.io/retail-api-docs/202211.html

Generates the necessary information to upload an item image.

```APIDOC
## POST /retail/202211/items/image_upload

### Description
Generates the necessary information to upload an item image. The response provides a signature and endpoint to perform the actual file upload.

### Method
POST

### Endpoint
https://api.stores.dev/retail/202211/items/image_upload

### Parameters
#### Request Body
- **name** (string) - Required - File name.
- **content_type** (string) - Required - File type (image/png, image/jpg, image/jpeg, image/pjpeg, image/gif).
- **size** (integer) - Required - File size in bytes (max 5MB).

### Response
#### Success Response (200)
- **signature** (object) - Upload signature details.
- **post_endpoint** (string) - The endpoint to POST the file to.
```

--------------------------------

### PATCH /retail/202211/orders/{order_id}/deliveries

Source: https://heyinc.github.io/retail-api-docs/202211.html

指定オーダーに対し、配送情報を更新します。発送完了以外の項目を更新可能です。

```APIDOC
## PATCH /retail/202211/orders/{order_id}/deliveries

### Description
指定オーダーに対し、配送情報を更新します。配送情報一括登録機能で登録可能な項目を更新します。更新対象は「発送完了」以外の項目です。

### Method
PATCH

### Endpoint
https://api.stores.dev/retail/202211/orders/{order_id}/deliveries

### Parameters
#### Path Parameters
- **order_id** (string) - Required - オーダーID。本ドキュメント記載のオーダー一覧から取得できるidを指定してください。

#### Request Body
- **delivery_method_name** (string) - Optional - 配送方法（配送会社などの配送情報、20文字以内）
- **estimated_arrival_date** (string) - Optional - 到着予定日（30文字以内）
- **tracking_number** (string) - Optional - 問い合わせ番号など（20文字以内）
- **shipped_mail_message** (string) - Optional - 備考（購入者様に送られる発送完了メールにメッセージを含めることができます、1000文字以内）

### Request Example
{
  "delivery_method_name": "string",
  "estimated_arrival_date": "2019-08-24T14:15:22Z",
  "tracking_number": "012030485",
  "shipped_mail_message": "配送情報メモ"
}

### Response
#### Success Response (200)
- **id** (string) - オーダーID
- **email** (string) - 購入者メールアドレス
- **number** (string) - オーダー番号
- **total_amount** (number) - 合計金額

#### Response Example
{
  "id": "624ec8c2768f72913ffe9694",
  "email": "hoge@example.com",
  "number": "6187637539"
}
```

--------------------------------

### POST /retail/202211/orders/{order_id}/shipped

Source: https://heyinc.github.io/retail-api-docs/202211.html

Performs the shipping completion process for a specified order.

```APIDOC
## POST /retail/202211/orders/{order_id}/shipped

### Description
Performs the shipping completion process for a specified order. If the shipping completion email feature is enabled, an email will be sent to the customer.

### Method
POST

### Endpoint
https://api.stores.dev/retail/202211/orders/{order_id}/shipped

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The unique order ID.

### Response
#### Success Response (200)
- **id** (string) - Order ID.
- **email** (string) - Customer email.
- **number** (string) - Order number.

#### Response Example
{
  "id": "624ec8c2768f72913ffe9694",
  "email": "hoge@example.com",
  "number": "6187637539"
}
```

--------------------------------

### Image Upload Information Response

Source: https://heyinc.github.io/retail-api-docs/202211.html

JSON response containing the signature and endpoint required to perform the actual file upload.

```json
{
  "signature": {
    "key": "sample.jpg",
    "Expires": "2021-12-09T12:30:00+09:00",
    "Content-Type": "image/jpeg",
    "success_action_status": "201",
    "acl": "public-read",
    "Cache-Control": "max-age=31536000",
    "policy": "policy-example",
    "x-amz-credential": "credential/20230328/ap-northeast-1/s3/aws4_request",
    "x-amz-algorithm": "AWS4-HMAC-SHA256",
    "x-amz-date": "20230328T120121Z",
    "x-amz-signature": "signature-example"
  },
  "post_endpoint": "https://s3-ap-northeast-1.amazonaws.com/retail-202211"
}
```
Tokens:
Raw