BASE API

https://docs.thebase.in/api
Admin
BASE API allows developers to integrate their applications with the BASE e-commerce platform,...
Tokens:40,183
Snippets:167
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Item Detail JSON Response Example

Source: https://docs.thebase.in/api/items/detail

Example of a partial JSON response for an item with a text-input option.

```json
"option_id":4,  

        "option_name":"文字入れ式オプション",  

        "option_type":"form",  

        "required":false,  

        "select":null,  

        "list_order":4,  

        "form":{  

          "option_variation_id":7,  

          "price":300,  

          "free_text_description":"補足説明",  

          "free_text_max_length":30,  

          "list_order":1  

        }  

      }  

    ]  

  }  

}
```

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

### Order Status Update Response Example

Source: https://docs.thebase.in/api/orders/edit_status

Example JSON response structure returned after a successful order status update request.

```json
{

  "order":{

    "unique_key":"154D88A39E454289",

    "ordered":1396419762,

    "cancelled":null,

    "dispatched":1396509935,

    "payment":"代金引換",

    "shipping_method":"ヤマト運輸",

    "shipping_fee":500,

    "cod_fee":300,

    "total":5800
    "first_name":"太郎",

    "last_name":"山田",

    "country":"Japan",

    "country_code":"JP",

    "zip_code":"106-0032",

    "prefecture":"東京都",

    "address":"港区六本木",

    "address2":"4-11-4 六本木ビル 301",

    "mail_address":"mail@example.com",

    "tel":"03-1234-5678",

    "remark":"午前中の配送を希望します。",

    "add_comment":"[配送業者]佐川急便 [送り状番号]123412341234",

    "delivery_company_id":3,

    "tracking_number":"123412341234",

    "delivery_date":"2018-03-19",

    "delivery_time_zone":"0812",

    "terminated":false,

    "dispatch_status":"dispatched",

    "modified":1396509935,

    "order_receiver":{

      "first_name":"花子",

      "last_name":"山田",

      "zip_code":"150-0043",

      "prefecture":"東京都",

      "address":"渋谷区道玄坂",

      "address2":"2-10-12 新大宗ビル3号館 531号",

      "tel":"03-1234-5678"
      "country":"Japan",

      "country_code":"JP"

    },

    "order_discount":{

      "discount":1000,

      "note":"初売りクーポン",

      "is_allocate_user_balance_log":0

    },

    "order_amount_adjustment":{

      "adjusted_amount":-100

    },

    "order_header_coin":{

      "discount":1000,

      "note":"コイン「HOGEコイン」の利用"

    },

    "order_charge":{

      "collected_fee":100

    },

    "additional_charges":[

      {

        "name":"オプション機能名1",

        "collected_fee":100

      },

      {

        "name":"オプション機能名2",

        "collected_fee":200

      }

    ],

    "fee_type":"base",

    "c_c_payment_transaction":{

      "collected_fee":200,

      "status":"captured"

    },

    "cvs_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "bt_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "atobarai_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "carrier_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "paypal_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "amazon_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "paypay_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "coin_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "bnpl_payment_transaction":{

      "collected_fee":null,

      "status":null

    },

    "user_balance_logs":[

      {

        "text":"154D88A39E454289の売上が確定しました",

        "price":7048,

        "created":1396509935

      },

      {

        "text":"154D88A39E454289のヤマト配送料",

        "price":-500,

        "created":1396509935

      },

      {

        "text":"154D88A39E454289のヤマト配送料の差額",

        "price":-200,

        "created":1396519935

      },

      {

        "text":"154D88A39E454289のの日本郵便配送料",

        "price":-500,

        "created":1396509935

      },

      {

        "text":"154D88A39E454289の日本郵便配送料の差額",

        "price":-200,

        "created":1396519935

       }

    ],

    "order_items":[

      {

        "order_item_id":123,

        "item_id":1001,

        "variation_id":101,
```

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

### GET /1/items

Source: https://docs.thebase.in/api

Retrieves a list of items for the shop.

```APIDOC
## GET /1/items

### Description
Retrieves a list of product information for the shop.

### Method
GET

### Endpoint
/1/items
```

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

### GET /1/items

Source: https://docs.thebase.in/api/items

商品情報の一覧を取得するエンドポイントです。公開ステータスや並び替え、カテゴリIDなどでフィルタリングが可能です。

```APIDOC
## GET /1/items

### Description
商品情報の一覧を取得します。scope: read_items

### Method
GET

### Endpoint
/1/items

### Parameters
#### Query Parameters
- **visible** (integer) - Optional - 公開ステータス 1:表示、0:非表示
- **order** (string) - Optional - 並び替え項目。list_order、created、modifiedのいずれか (デフォルト: list_order)
- **sort** (string) - Optional - 並び順。asc か desc のいずれか (デフォルト: asc)
- **limit** (integer) - Optional - リミット (デフォルト: 20, MAX: 100)
- **offset** (integer) - Optional - オフセット (デフォルト: 0)
- **max_image_no** (integer) - Optional - 画像番号 1~20 (デフォルト: 5)
- **image_size** (string) - Optional - 画像サイズ。origin、76、146、300、500、640、sp_480、sp_640からカンマ区切りで複数指定 (デフォルト: origin)
- **category_id** (integer) - Optional - カテゴリID

### Response
#### Success Response (200)
- **items** (array) - 商品情報のリスト

#### Response Example
{
  "items": [
    {
      "item_id": 1234,
      "title": "Tシャツ",
      "detail": "とってもオシャレなTシャツです。",
      "price": 3900,
      "proper_price": null,
      "item_tax_type": 1,
      "stock": 10,
      "visible": 1,
      "list_order": 1,
      "identifier": "abcd-1234",
      "img1_origin": "https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",
      "modified": 1414731171,
      "variations": [
        {
          "variation_id": 11,
          "variation": "黒色",
          "variation_stock": 6
        }
      ]
    }
  ]
}
```

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

### Authorization Request URL Example

Source: https://docs.thebase.in/api/oauth/authorize

Construct a link using these query parameters to initiate the user authorization flow.

```text
https://api.thebase.in/1/oauth/authorize?response_type=code&client_id=abc123&redirect_uri=http%3A%2F%2Fexample.com%2Fcallback.php&scope=read_users%20read_orders&state=hogehoge
```

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

### Retrieve shop information response

Source: https://docs.thebase.in/api/users/me

Example of a successful JSON response containing shop metadata and configuration.

```json
{

  "user":{

    "shop_id":"shop",

    "shop_name":"BASEショップ",

    "shop_introduction":"BASEのノベルティショップです。",

    "shop_url":"http://shop.thebase.in",

    "twitter_id":"baseec",

    "facebook_id":"baseec",

    "ameba_id":"baseec",

    "instagram_id":"baseec",

    "line_id":"baseec",

    "youtube_id":"baseec",

    "note_id":"baseec",

    "tiktok_id":"baseec",

    "background":null,

    "display_background":1,

    "repeat_background":1,

    "logo":"https://baseec.s3.amazonaws.com/images/user/logo/c11fbd023b998035d0b813962ca77062.png",

    "display_logo":1,

    "mail_address":"hoge@example.com"

  }

}
```

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

### Response Example for Add Image

Source: https://docs.thebase.in/api/items/add_image

The JSON response structure returned after successfully adding an image to a product item.

```json
{

  "item":{

    "item_id":1234,

    "title":"Tシャツ",

    "detail":"とってもオシャレなTシャツです。",

    "price":3900,

    "proper_price":null,

    "stock":10,

    "visible":1,

    "list_order":1,

    "identifier":"abcd-1234",

    "modified":1414731174,



    "img1_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",

    "img1_76":null,

    "img1_146":null,

    "img1_300":null,

    "img1_500":null,

    "img1_640":null,

    "img1_sp_480":null,

    "img1_sp_640":null,



    "img2_origin":null,

    "img2_76":null,

    "img2_146":null,

    "img2_300":null,

    "img2_500":null,

    "img2_640":null,

    "img2_sp_480":null,

    "img2_sp_640":null,



    "img3_origin":null,

    "img3_76":null,

    "img3_146":null,

    "img3_300":null,

    "img3_500":null,

    "img3_640":null,

    "img3_sp_480":null,

    "img3_sp_640":null,



    "img4_origin":null,

    "img4_76":null,

    "img4_146":null,

    "img4_300":null,

    "img4_500":null,

    "img4_640":null,

    "img4_sp_480":null,

    "img4_sp_640":null,



    "img5_origin":null,

    "img5_76":null,

    "img5_146":null,

    "img5_300":null,

    "img5_500":null,

    "img5_640":null,

    "img5_sp_480":null,

    "img5_sp_640":null,



    "variations":[

      {

        "variation_id":11,

        "variation":"黒",

        "variation_stock":6,

        "variation_identifier":"abcd-1234-b",

        "barcode":"abcd-1234-b"

      },

      {

        "variation_id":12,

        "variation":"白",

        "variation_stock":4,

        "variation_identifier":"abcd-1234-w",

        "barcode":"abcd-1234-w"

      }

    ],



    "options":[

      {

        "option_id":3,

        "option_name":"選択式オプション",

        "option_type":"select",

        "required":true,

        "list_order":3,

        "select":{

          "option_variations":[

            {

              "option_variation_id":5,

              "variation_name":"選択式項目その1",

              "price":100,

              "list_order":1

            },

            {

              "option_variation_id":6,

              "variation_name":"選択式項目その2",

              "price":200,

              "list_order":2

            }

          ]

        },

        "form":null

      },

      {

        "option_id":4,

        "option_name":"文字入れ式オプション",

        "option_type":"form",

        "required":false,

        "select":null,

        "list_order":4,

        "form":{

          "option_variation_id":7,

          "price":300,

          "free_text_description":"補足説明",

          "free_text_max_length":30,

          "list_order":1

        }

      }

    ]

  }

}
```

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

### GET /1/users/me

Source: https://docs.thebase.in/api

Retrieves the authenticated shop's information.

```APIDOC
## GET /1/users/me

### Description
Retrieves the information of the currently authenticated shop.

### Method
GET

### Endpoint
/1/users/me
```

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

### GET /1/orders

Source: https://docs.thebase.in/api

Retrieves a list of orders for the shop.

```APIDOC
## GET /1/orders

### Description
Retrieves a list of order information for the shop.

### Method
GET

### Endpoint
/1/orders
```

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

### Error Response Examples

Source: https://docs.thebase.in/api/categories/edit

Various error scenarios encountered when the request fails.

```json
{

  "error":"access_denied",

  "error_description":"httpsでアクセスしてください。"

}
```

```json
{

  "error":"invalid_request",

  "error_description":"アクセストークンが無効です。"

}
```

```json
{

  "error":"invalid_scope",

  "error_description":"スコープが無効です。"

}
```

```json
{

  "error":"not_post_method",

  "error_description":"POSTで送信してください。"

}
```

```json
{

  "error":"bad_category_id",

  "error_description":"不正なcategory_idです。"

}
```

```json
{

  "error":"validation_error",

  "error_description":"バリデーションエラーです。"

}
```

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

### Retrieve Order List Response

Source: https://docs.thebase.in/api/orders

Example JSON response containing a list of orders with their respective details and subscription information.

```json
{

  "orders":[  

    {  

      "unique_key":"154D88A39E454289",  

      "ordered":1396419762,  

      "cancelled":null,  

      "dispatched":1396528943,  

      "payment":"creditcard",  

      "first_name":"太郎",  

      "last_name":"山田",  

      "total":2000,  

      "delivery_date":"2018-03-19",  

      "delivery_time_zone":"0812",  

      "terminated":true,  

      "dispatch_status":"dispatched",  

      "modified":1396528943,  

      "subscription": {  

        "unique_key": "SABCDEF123456780",  

        "repeat_number": 1,  

        "repeat_times": 12  

      },  

    },  

    {  

      "unique_key":"9CD3594222D78673",  

      "ordered":1392345522,  

      "cancelled":null,  

      "dispatched":null,  

      "payment":"cvs",  

      "first_name":"花子",  

      "last_name":"山田",  

      "total":3500,  

      "delivery_date":null,  

      "delivery_time_zone":null,  

      "terminated":false,  

      "dispatch_status":"unpaid",  

      "modified":1392345522,  

      "subscription": {  

        "unique_key": null,  

        "repeat_number": null,  

        "repeat_times": null  

      },  

    }  

  ]  

}
```

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

### GET /1/search/refresh

Source: https://docs.thebase.in/api/search/refresh

Retrieves updated information for specific products within a shop.

```APIDOC
## GET /1/search/refresh

### Description
Retrieves the latest information for products that were previously obtained via search. Note that this endpoint does not return information if the product or shop has been deleted.

### Method
GET

### Endpoint
/1/search/refresh

### Parameters
#### Query Parameters
- **client_id** (string) - Required - Search API specific client ID.
- **client_secret** (string) - Required - Search API specific client secret.
- **item_id** (string) - Required - Product ID(s). Multiple IDs can be specified as a comma-separated list (max 50).
- **shop_id** (string) - Required - The ID of the shop.

### Response
#### Success Response (200)
- **items** (array) - List of product objects containing updated details such as title, price, stock, and image URLs.

#### Response Example
{
  "items": [
    {
      "item_id": 1234,
      "title": "Tシャツ",
      "detail": "とってもオシャレなTシャツです。",
      "price": 3900,
      "stock": 10,
      "shop_id": "shop",
      "shop_name": "BASEショップ",
      "shop_url": "http://shop.thebase.in"
    }
  ]
}
```

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

### Error Response Examples

Source: https://docs.thebase.in/api/item_categories/delete

Various error scenarios including authentication, validation, and database issues.

```json
{

  "error":"access_denied",

  "error_description":"httpsでアクセスしてください。"

}
```

```json
{

  "error":"invalid_request",

  "error_description":"アクセストークンが無効です。"

}
```

```json
{

  "error":"invalid_scope",

  "error_description":"スコープが無効です。"

}
```

```json
{

  "error":"not_post_method",

  "error_description":"POSTで送信してください。"

}
```

```json
{

  "error":"bad_item_category_id",

  "error_description":"不正なitem_category_idです。"

}
```

```json
{

  "error":"db_error",

  "error_description":"DBエラーです。"

}
```

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

### Item Option JSON Structure

Source: https://docs.thebase.in/api/items/search

Example of the JSON structure for item options, including both select-type and form-type configurations.

```json
          "list_order":3,  

          "select":{  

            "option_variations":[  

              {  

                "option_variation_id":5,  

                "variation_name":"選択式項目その1",  

                "price":100,  

                "list_order":1  

              },  

              {  

                "option_variation_id":6,  

                "variation_name":"選択式項目その2",  

                "price":200,  

                "list_order":2  

              }  

            ]  

          },  

          "form":null  

        },  

        {  

          "option_id":4,  

          "option_name":"文字入れ式オプション",  

          "option_type":"form",  

          "required":false,  

          "select":null,  

          "list_order":4,  

          "form":{  

            "option_variation_id":7,  

            "price":300,  

            "free_text_description":"補足説明",  

            "free_text_max_length":30,  

            "list_order":1  

          }  

        }  

      ]  

    }  

  ]  

}
```

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

### Retrieve savings list response

Source: https://docs.thebase.in/api/savings

Example JSON response containing a list of bank transfer applications.

```json
{

  "savings":[

    {

      "saving_id":123,

      "bank_name":"りそな銀行",

      "branch_name":"赤坂支店",

      "account_type":"普通",

      "account_name":"ヤマダタロウ",

      "account_number":"1234567",

      "drawings":100000,

      "administrative_fee": 0,

      "bank_transfer_fee": 250,

      "early_transfer_fee": 0,

      "due_date":"2014-09-01",

      "status":"done",

      "created":1397549706

    },

    {

      "saving_id":223,

      "bank_name":"みずほ銀行",

      "branch_name":"渋谷支店",

      "account_type":"普通",

      "account_name":"ヤマダタロウ",

      "account_number":"1234567",

      "drawings":200000,

      "administrative_fee": 0,

      "bank_transfer_fee": 250,

      "early_transfer_fee": 0,

      "due_date":"2014-10-01",

      "status":"requested",

      "created":1398848221

    }

  ]

}
```

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

### Response Example for Delete Image

Source: https://docs.thebase.in/api/items/delete_image

The JSON response structure returned after successfully deleting a product image.

```json
{

  "item":{

    "item_id":1234,

    "title":"Tシャツ",

    "detail":"とってもオシャレなTシャツです。",

    "price":3900,

    "proper_price":null,

    "stock":10,

    "visible":1,

    "list_order":1,

    "identifier":"abcd-1234",

    "modified":1414731174,



    "img1_origin":null,

    "img1_76":null,

    "img1_146":null,

    "img1_300":null,

    "img1_500":null,

    "img1_640":null,

    "img1_sp_480":null,

    "img1_sp_640":null,



    "img2_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",

    "img2_76":null,

    "img2_146":null,

    "img2_300":null,

    "img2_500":null,

    "img2_640":null,

    "img2_sp_480":null,

    "img2_sp_640":null,



    "img3_origin":null,

    "img3_76":null,

    "img3_146":null,

    "img3_300":null,

    "img3_500":null,

    "img3_640":null,

    "img3_sp_480":null,

    "img3_sp_640":null,



    "img4_origin":null,

    "img4_76":null,

    "img4_146":null,

    "img4_300":null,

    "img4_500":null,

    "img4_640":null,

    "img4_sp_480":null,

    "img4_sp_640":null,



    "img5_origin":null,

    "img5_76":null,

    "img5_146":null,

    "img5_300":null,

    "img5_500":null,

    "img5_640":null,

    "img5_sp_480":null,

    "img5_sp_640":null,



    "variations":[

      {

        "variation_id":11,

        "variation":"黒",

        "variation_stock":6,

        "variation_identifier":"abcd-1234-b",

        "barcode":"abcd-1234-b"

      },

      {

        "variation_id":12,

        "variation":"白",

        "variation_stock":4,

        "variation_identifier":"abcd-1234-w",

        "barcode":"abcd-1234-w"

      }

    ],



    "options":[

      {

        "option_id":3,

        "option_name":"選択式オプション",

        "option_type":"select",

        "required":true,

        "list_order":3,

        "select":{

          "option_variations":[

            {

              "option_variation_id":5,

              "variation_name":"選択式項目その1",

              "price":100,

              "list_order":1

            },

            {

              "option_variation_id":6,

              "variation_name":"選択式項目その2",

              "price":200,

              "list_order":2

            }

          ]

        },

        "form":null

      },

      {

        "option_id":4,

        "option_name":"文字入れ式オプション",

        "option_type":"form",

        "required":false,

        "select":null,

        "list_order":4,

        "form":{

          "option_variation_id":7,

          "price":300,

          "free_text_description":"補足説明",

          "free_text_max_length":30,

          "list_order":1

        }

      }

    ]

  }

}
```

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

### Retrieve items response example

Source: https://docs.thebase.in/api/items

Successful response structure containing an array of item objects with their respective attributes and variations.

```json
{

  "items":[

    {

      "item_id":1234,

      "title":"Tシャツ",

      "detail":"とってもオシャレなTシャツです。",

      "price":3900,

      "proper_price":null,

      "item_tax_type":1,

      "stock":10,

      "visible":1,

      "list_order":1,

      "identifier":"abcd-1234",

      "img1_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",

      "img2_origin":"https://base-ec2.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg",

      "img3_origin":null,

      "img4_origin":null,

      "img5_origin":null,

      "modified":1414731171,

      "variations":[

        {

          "variation_id":11,

          "variation":"黒色",

          "variation_stock":6,

          "variation_identifier":"abcd-1234-b",

          "barcode":"abcd-1234-b"

        },

        {

          "variation_id":12,

          "variation":"白色",

          "variation_stock":4,

          "variation_identifier":"abcd-1234-w",

          "barcode":"abcd-1234-w"

        }

      ]

    },

    {

      "item_id":12345,

      "title":"ロングTシャツ",

      "price":4900,

      "proper_price":null,

      "item_tax_type":1,

      "stock":20,

      "visible":1,

      "list_order":2,

      "identifier":null,

      "img1_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",

      "img2_origin":"https://base-ec2.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg",

      "img3_origin":null,

      "img4_origin":null,

      "img5_origin":null,

      "modified":1414731172,

      "variations":[

        {

          "variation_id":21,

          "variation":"Mサイズ",

          "variation_stock":12,

          "variation_identifier":null,

          "barcode":null

        },

        {

          "variation_id":22,

          "variation":"Lサイズ",

          "variation_stock":8,

          "variation_identifier":null,

          "barcode":null

        }

      ]

    }

  ]

}
```

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

### GET /1/categories

Source: https://docs.thebase.in/api/categories

Retrieves a list of all available categories.

```APIDOC
## GET /1/categories

### Description
Retrieves a list of category information.

### Method
GET

### Endpoint
/1/categories

### Scope
read_items

### Response
#### Success Response (200)
- **categories** (array) - List of category objects
  - **category_id** (integer) - Unique ID for the category
  - **name** (string) - Category name
  - **list_order** (integer) - Display order of the category
  - **number** (integer) - Category number
  - **parent_number** (integer) - Parent category number
  - **code** (string) - Category code (hyphen-separated numbers, max 3 levels)

#### Response Example
{
  "categories": [
    {
      "category_id": 1234,
      "name": "メンズ",
      "list_order": 1,
      "number": 1,
      "parent_number": 0,
      "code": "0001"
    }
  ]
}

### Error Handling
- **access_denied**: Ensure the request is made via HTTPS.
- **invalid_request**: The access token is invalid.
- **invalid_scope**: The provided scope is invalid.
```

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

### Item Registration Response Example

Source: https://docs.thebase.in/api/items/add

A JSON response structure returned after successfully registering a new item, including details on variations and options.

```json
{

  "item":{

    "item_id":1234,

    "title":"Tシャツ",

    "detail":"とってもオシャレなTシャツです。",

    "price":3900,

    "proper_price":null,

    "item_tax_type":1,

    "stock":10,

    "visible":1,

    "list_order":1,

  　"identifier":"abcd-1234",

    "modified":1414731174,



    "img1_origin":null,

    "img1_76":null,

    "img1_146":null,

    "img1_300":null,

    "img1_500":null,

    "img1_640":null,

    "img1_sp_480":null,

    "img1_sp_640":null,



    "img2_origin":null,

    "img2_76":null,

    "img2_146":null,

    "img2_300":null,

    "img2_500":null,

    "img2_640":null,

    "img2_sp_480":null,

    "img2_sp_640":null,



    "img3_origin":null,

    "img3_76":null,

    "img3_146":null,

    "img3_300":null,

    "img3_500":null,

    "img3_640":null,

    "img3_sp_480":null,

    "img3_sp_640":null,



    "img4_origin":null,

    "img4_76":null,

    "img4_146":null,

    "img4_300":null,

    "img4_500":null,

    "img4_640":null,

    "img4_sp_480":null,

    "img4_sp_640":null,



    "img5_origin":null,

    "img5_76":null,

    "img5_146":null,

    "img5_300":null,

    "img5_500":null,

    "img5_640":null,

    "img5_sp_480":null,

    "img5_sp_640":null,



    "variations":[

      {

        "variation_id":11,

        "variation":"黒",

        "variation_stock":6,

        "variation_identifier":"abcd-1234-b",

        "barcode":"abcd-1234-b"

      },

      {

        "variation_id":12,

        "variation":"白",

        "variation_stock":4,

        "variation_identifier":"abcd-1234-w",

        "barcode":"abcd-1234-w"

      }

    ],



    "options":[

      {

        "option_id":3,

        "option_name":"選択式オプション",

        "option_type":"select",

        "required":true,

        "list_order":3,

        "select":{

          "option_variations":[

            {

              "option_variation_id":5,

              "variation_name":"選択式項目その1",

              "price":100,

              "list_order":1

            },

            {

              "option_variation_id":6,

              "variation_name":"選択式項目その2",

              "price":200,

              "list_order":2

            }

          ]

        },

        "form":null

      },

      {

        "option_id":4,

        "option_name":"文字入れ式オプション",

        "option_type":"form",

        "required":false,

        "select":null,

        "list_order":4,

        "form":{

          "option_variation_id":7,

          "price":300,

          "free_text_description":"補足説明",

          "free_text_max_length":30,

          "list_order":1

        }

      }

    ]

  }

}
```

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

### POST /1/items/add

Source: https://docs.thebase.in/api/items/add

Registers a new product. Note that there is a daily limit of 1000 product registrations.

```APIDOC
## POST /1/items/add

### Description
Registers a new product in the system. Note that there is a daily limit of 1000 product registrations.

### Method
POST

### Endpoint
/1/items/add

### Parameters
#### Request Body
- **title** (string) - Required - 商品名
- **detail** (string) - Optional - 商品説明
- **price** (number) - Required - 価格
- **item_tax_type** (number) - Optional - 税率設定フラグ。1:標準税率、2:軽減税率 (デフォルト:1)
- **stock** (number) - Required - 在庫数
- **visible** (number) - Optional - 1:表示、0:非表示 (デフォルト:1)
- **identifier** (string) - Optional - 商品コード
- **list_order** (number) - Optional - 表示順
- **variation[]** (array) - Optional - バリエーションの種類
- **variation_stock[]** (array) - Optional - バリエーションの在庫数
- **variation_identifier[]** (array) - Optional - バリエーションの種類コード
- **barcode[]** (array) - Optional - バリエーションのJAN/GTIN

### Response
#### Success Response (200)
- **item** (object) - The registered product object containing item_id, title, detail, price, stock, and other metadata.
```

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

### Callback URL Examples

Source: https://docs.thebase.in/api/oauth/authorize

The callback URL receives either an authorization code upon success or an error parameter if the user denies access.

```text
http://example.com/callback.php?code=3362cb43d7b3d5f4af219eff80ceba8b&state=hogehoge
```

```text
http://example.com/callback.php?error=access_denied&state=hogehoge
```

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

### GET /1/delivery_companies

Source: https://docs.thebase.in/api/delivery_companies

Retrieves a list of all delivery companies.

```APIDOC
## GET /1/delivery_companies

### Description
Retrieves a list of delivery company information.

### Method
GET

### Endpoint
/1/delivery_companies

### Response
#### Success Response (200)
- **delivery_companies** (array) - List of delivery companies
  - **delivery_company_id** (integer) - Delivery company ID
  - **name** (string) - Delivery company name

#### Response Example
{
  "delivery_companies": [
    {
      "delivery_company_id": 1,
      "name": "クロネコヤマト"
    },
    {
      "delivery_company_id": 2,
      "name": "佐川急便"
    },
    {
      "delivery_company_id": 3,
      "name": "日本通運"
    }
  ]
}
```

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

### GET /1/items/detail/:item_id

Source: https://docs.thebase.in/api

Retrieves detailed information for a specific item.

```APIDOC
## GET /1/items/detail/:item_id

### Description
Retrieves detailed information for a specific product.

### Method
GET

### Endpoint
/1/items/detail/:item_id

### Parameters
#### Path Parameters
- **item_id** (string) - Required - The unique identifier of the item.
```

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

### Search Items Response Example

Source: https://docs.thebase.in/api/items/search

A sample JSON response structure returned by the search items endpoint, including item details, images, and variations.

```json
{

  "items":[

    {

      "item_id":1234,

      "title":"Tシャツ",

      "detail":"とってもオシャレなTシャツです。",

      "price":3900,

      "proper_price":null,

      "item_tax_type":1,

      "stock":10,

      "visible":1,

      "list_order":1,

      "identifier":null,

      "modified":1414731174,

  

      "img1_origin":"https://base-ec2.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg",

      "img1_76":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=76,type=normal",

      "img1_146":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=146,type=normal",

      "img1_300":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=300,type=normal",

      "img1_500":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=500,type=normal",

      "img1_640":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=640,type=normal",

      "img1_sp_480":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=480,height=480,aspect=fill,type=downsize;Crop,width=480,height=480,gravity=Center",

      "img1_sp_640":"https://baseec-img-mng.akamaized.net/images/item/origin/45fc036c772c8469fa40396b2ef0fb9b.jpg?imformat=generic&q=90&im=Resize,width=640,height=640,aspect=fill,type=downsize;Crop,width=640,height=640,gravity=Center",

  

      "img2_origin":"https://base-ec2.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg",

      "img2_76":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=76,type=normal",

      "img2_146":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=146,type=normal",

      "img2_300":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=300,type=normal",

      "img2_500":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=500,type=normal",

      "img2_640":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=640,type=normal",

      "img2_sp_480":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=480,height=480,aspect=fill,type=downsize;Crop,width=480,height=480,gravity=Center",

      "img2_sp_640":"https://baseec-img-mng.akamaized.net/images/item/origin/2a4de4965fa23b7b89944199713a827e.jpg?imformat=generic&q=90&im=Resize,width=640,height=640,aspect=fill,type=downsize;Crop,width=640,height=640,gravity=Center",

  

      "img3_origin":null,

      "img3_76":null,

      "img3_146":null,

      "img3_300":null,

      "img3_500":null,

      "img3_640":null,

      "img3_sp_480":null,

      "img3_sp_640":null,

  

      "img4_origin":null,

      "img4_76":null,

      "img4_146":null,

      "img4_300":null,

      "img4_500":null,

      "img4_640":null,

      "img4_sp_480":null,

      "img4_sp_640":null,

  

      "img5_origin":null,

      "img5_76":null,

      "img5_146":null,

      "img5_300":null,

      "img5_500":null,

      "img5_640":null,

      "img5_sp_480":null,

      "img5_sp_640":null,

  

      "variations":[

        {

          "variation_id":11,

          "variation":"黒色",

          "variation_stock":6,

          "variation_identifier":null,

          "barcode":null

        },

        {

          "variation_id":12,

          "variation":"白色",

          "variation_stock":4,

          "variation_identifier":null,

          "barcode":null

        }

      ],

      "options":[

        {

          "option_id":3,

          "option_name":"選択式オプション",

          "option_type":"select",

          "required":true,
```

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

### GET /1/orders/detail/:unique_key

Source: https://docs.thebase.in/api

Retrieves detailed information for a specific order.

```APIDOC
## GET /1/orders/detail/:unique_key

### Description
Retrieves detailed information for a specific order.

### Method
GET

### Endpoint
/1/orders/detail/:unique_key

### Parameters
#### Path Parameters
- **unique_key** (string) - Required - The unique key of the order.
```
Tokens:
Raw