NAV Navbar
cURL
  • 概要
  • 認可
  • 出荷
  • 料金
  • 運送会社
  • 追跡情報
  • 住所
  • 倉庫
  • サブユーザー
  • 共通定義
  • エラー
  • 概要

    Ship&Co APIドキュメントへようこそ!このドキュメントではShip&CoのAPIの使い方について説明します。

    Ship&Coのアカウント登録はこちら

    APIを使うことで以下のようなことが実現できます。

    このドキュメントの想定読者

    APIの処理概要

    Diagram

    APIの使い方はとても簡単です。以下の2ステップで完了です。

    1. 認可
    2. API コール

    Postmanでサンプルコードを試す (`Language`で各プログラミング言語を選べます)

    免責事項

    認可

    全てのAPIコールに以下のHTTPヘッダーを追加してください

    curl "EACH_API_END_POINT" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    `YOUR_API_TOKEN_FROM_DASHBOARD`を取得したAPIトークンで置き換えてください

    Ship&Co APIは、APIダッシュボードから発行できるAPIトークンをHTTPヘッダーに指定することで認可され、利用できます。

    APIトークンの取得方法は以下です。

    1. Ship&Coダッシュボードにログインする
    2. [設定]メニューをクリックし、[API Settings]の[Token]に表示されているテキストをコピーする

    Dashboard

    コピーしたAPIトークンを以下のようにHTTPヘッダーに追加することでAPIを利用することができます。

    x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD

    サブユーザーのAPIトークンを使ってユーザーごとのデータ管理も可能です。詳細はサブユーザーを参照してください。

    ※APIトークンを新しく作成した場合は、以前のトークンは無効となりそれを使ったAPIの呼び出しもエラーとなりますのでご注意ください。

    出荷

    出荷情報の作成

    curl -v -X POST "https://app.shipandco.com/api/v1/shipments" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
      "to_address": {
        "full_name": "TEST TARO",
        "company": "",
        "email": "",
        "phone": "1111111111",
        "country": "JP",
        "address1": "京都市中京区八百屋町117",
        "address2": "",
        "province": "",
        "zip": "604-8072",
        "city": "京都府"
      },
      "from_address": {
        "full_name": "テスト",
        "company": "",
        "email": "",
        "phone": "08012341234",
        "country": "JP",
        "address1": "OSAKAFU",
        "address2": "",
        "province": "OSAKA",
        "zip": "1234567",
        "city": "IBARAKI SHI"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": "2",
          "price": "4850",
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball2",
          "quantity": "2",
          "price": "4850",
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball3",
          "quantity": "2",
          "price": "4850",
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball4",
          "quantity": "2",
          "price": "4850",
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball5",
          "quantity": "2",
          "price": "4850",
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        }
      ],
      "parcels": [
        {
          "amount": "1",
          "width": "10",
          "height": "10",
          "depth": "10",
          "weight": 2000
        }
      ],
      "customs": {
        "duty_paid": false,
        "content_type": "MERCHANDISE"
      },
      "setup": {
        "carrier": "sagawa",
        "service": "sagawa_regular",
        "currency": "JPY",
        "date": "",
        "time": "",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "signature": false,
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pack_size": "0",
        "pack_amount": 3,
        "cash_on_delivery": {
          "amount": 1000,
          "tax": 100
        },
        "return_label": false,
        "print_start_location": 1,
        "test": true
      }
    }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "id": "API-QWMHHRLQS8",
      "state": "active",
      "test": true,
      "created_at": "2019-08-31T07:14:20.209Z",
      "to_address": {
        "full_name": "TEST TARO",
        "company": "",
        "address1": "京都市中京区八百屋町117",
        "address2": "",
        "city": "京都府",
        "province": "",
        "zip": "604-8072",
        "country": "JP",
        "phone": "1111111111",
        "email": ""
      },
      "from_address": {
        "full_name": "テスト",
        "company": "",
        "address1": "OSAKAFU",
        "address2": "",
        "city": "IBARAKI SHI",
        "province": "OSAKA",
        "zip": "1234567",
        "country": "JP",
        "phone": "08012341234",
        "email": ""
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball2",
          "quantity": 2,
          "price": 4850,
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball3",
          "quantity": 2,
          "price": 4850,
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball4",
          "quantity": 2,
          "price": 4850,
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        },
        {
          "name": "Basket ball5",
          "quantity": 2,
          "price": 4850,
          "hs_code": "",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        }
      ],
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "pack_size": "0",
        "pack_amount": 3,
        "date": "",
        "time": "",
        "care": {
          "fragile": false,
          "side_up": false,
          "valuable_goods": false
        },
        "pick_up": false
      },
      "delivery": {
        "carrier": "sagawa",
        "method": "sagawa_regular",
        "tracking_numbers": [
          "514699854874"
        ],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201908/k3wWYYwk8Q8h46NcM/voxZSt9fYeeWzFssm.pdf",
        "warnings": [ "DUMMY_WARNING" ]
      }
    }
    

    指定した荷受人住所や荷物、製品情報、運送会社の情報を元に配送ラベル付きの出荷情報を作成します。

    テスト環境について:リクエスト内容の`setup`に`"test": true`を追加することで課金対象外のテストラベルを発行することができます。テストラベル発行にはクレジットカード登録は不要ですが、配送に使うこともできません。テストラベルはUPS, FedEx, DHL, Sagawa and Yamatoでのみ利用可能です。

    リクエスト

    POST https://app.shipandco.com/api/v1/shipments

    項目 説明 必須情報
    to_address 荷受人住所です。
    注:`province`はコードがある国の場合名称ではなくコードで指定する必要があります。(例:アメリカのカルフォルニアの場合`CA`)
    ※住所の最大長は運送会社やサービスで異なります。(例: DHLはaddress1とaddress2それぞれ45文字、合計90文字まで指定可能)
    full_name, phone (一部のサービスのみ), country, address1, province (存在する国の場合のみ), city (存在する国の場合のみ), zip (存在する国の場合のみ)
    from_address 発送人住所です。
    注:`province`はコードがある国の場合名称ではなくコードで指定する必要があります。(例:アメリカのカルフォルニアの場合`CA`)
    ※住所の最大長は運送会社やサービスで異なります。(例: DHLはaddress1とaddress2それぞれ45文字、合計90文字まで指定可能)
    full_name, phone, country, address1, province (存在する国の場合のみ), city (存在する国の場合のみ), zip (存在する国の場合のみ)
    parcels 荷物情報です。※国内の荷物情報はこのパラメータではなく、`setup`の荷物サイズと数量を使って指定してください。 amount, width, height, depth (最低1つの荷物情報が必要)
    products 製品情報です。 name, quantity, price, origin_country
    customs カスタム情報です。 content_type (一部のサービスのみ)
    setup 設定情報です。
    詳細は運送会社とサービスを参照してください。
    料金の一覧を利用して最適な`service`を探すこともできます。
    ※`"test": true`を追加することで課金されないダミーのラベルを発行することができます。
    carrier, service, currency

    各配送会社の実際に動作するサンプルリクエストはPostmanをご参照ください。

    レスポンス

    項目 説明
    id 出荷情報の一意のIDです。GETで利用できます。
    delivery.carrier 指定した運送会社の名称です。
    delivery.tracking_numbers 出荷の追跡番号です。返送用ラベルも生成した場合は複数あります。
    delivery.label 作成されたラベルのイメージ情報です。返送用ラベルも生成した場合は複数ページ作成されます。
    delivery.warnings 運送会社固有の警告がある場合表示されます。(例:DHL PLTで対象外になった場合。DHL PLTの警告が表示された場合はこちらの内容をご確認ください)

    出荷情報の一覧

    curl -v -X GET "https://app.shipandco.com/api/v1/shipments?state=active&limit=2&page=1&created_after=2018-12-01T00:00:00.000Z&created_before=2019-01-30T00:00:00.000Z&carrier=sagawa" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
        "shipments": [
            {
                "id": "API-SGF5LYSJAF",
                "state": "active",
                "created_at": "2019-01-08T17:17:08.394Z",
                "to_address": {
                    "full_name": "太郎山田",
                    "address1": "京都市東山区",
                    "country": "JP",
                    "email": "yamada.taro@demo.com",
                    "phone": "08012341234",
                    "address2": "西海子町",
                    "address3": "神宮道",
                    "province": "京都府",
                    "zip": "6050012"
                },
                "from_address": {
                    "company": "株式会社ACME",
                    "address1": "中央区",
                    "country": "JP",
                    "email": "yamada.hanako@acme.com",
                    "phone": "08012341234",
                    "address2": "日本橋堀留町",
                    "address3": "タワー #1001",
                    "province": "東京都",
                    "zip": "1030012"
                },
                "products": [
                    {
                        "name": "Basket ball",
                        "quantity": 2,
                        "price": 4850,
                        "hs_code": ""
                    }
                ],
                "setup": {
                    "currency": "JPY",
                    "insurance": 0,
                    "ref_number": "",
                    "delivery_note": "",
                    "discount": 0,
                    "pack_size": "60",
                    "pack_amount": 1,
                    "date": "2019-01-10",
                    "time": "16-18",
                    "care": {
                        "fragile": false,
                        "side_up": false,
                        "valuable_goods": false
                    },
                    "pick_up": false,
                    "print_start_location": "4"
                },
                "delivery": {
                    "carrier": "sagawa",
                    "method": "sagawa_regular",
                    "tracking_numbers": [
                        "514699818076"
                    ],
                    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/WgnXig8zR6hEvZLWE.pdf"
                }
            },
            {
                "id": "API-RXILYS438A",
                "state": "active",
                "created_at": "2019-01-08T17:13:19.968Z",
                "to_address": {
                    "full_name": "太郎山田",
                    "address1": "京都市東山区",
                    "country": "JP",
                    "email": "yamada.taro@demo.com",
                    "phone": "08012341234",
                    "address2": "西海子町",
                    "address3": "神宮道",
                    "province": "京都府",
                    "zip": "6050012"
                },
                "from_address": {
                    "company": "株式会社ACME",
                    "address1": "中央区",
                    "country": "JP",
                    "email": "yamada.hanako@acme.com",
                    "phone": "08012341234",
                    "address2": "日本橋堀留町",
                    "address3": "タワー #1001",
                    "province": "東京都",
                    "zip": "1030012"
                },
                "products": [
                    {
                        "name": "Basket ball",
                        "quantity": 2,
                        "price": 4850,
                        "hs_code": ""
                    }
                ],
                "setup": {
                    "currency": "JPY",
                    "insurance": 0,
                    "ref_number": "",
                    "delivery_note": "",
                    "discount": 0,
                    "pack_size": "60",
                    "pack_amount": 1,
                    "date": "2019-01-10",
                    "time": "16-18",
                    "care": {
                        "fragile": false,
                        "side_up": false,
                        "valuable_goods": false
                    },
                    "pick_up": false,
                    "print_start_location": "4"
                },
                "delivery": {
                    "carrier": "sagawa",
                    "method": "sagawa_regular",
                    "tracking_numbers": [
                        "514699818065"
                    ],
                    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/Fu8f5dvB5zrmBTHfh.pdf"
                }
            },
            {
                "id": "API-Y72ITP6P8G",
                "state": "active",
                "created_at": "2019-01-08T17:05:12.663Z",
                "to_address": {
                    "full_name": "太郎山田",
                    "address1": "京都市東山区",
                    "country": "JP",
                    "email": "yamada.taro@demo.com",
                    "phone": "08012341234",
                    "address2": "西海子町",
                    "address3": "神宮道",
                    "province": "京都府",
                    "zip": "6050012"
                },
                "from_address": {
                    "company": "株式会社ACME",
                    "address1": "中央区",
                    "country": "JP",
                    "email": "yamada.hanako@acme.com",
                    "phone": "08012341234",
                    "address2": "日本橋堀留町",
                    "address3": "タワー #1001",
                    "province": "東京都",
                    "zip": "1030012"
                },
                "products": [
                    {
                        "name": "Basket ball",
                        "quantity": 2,
                        "price": 4850,
                        "hs_code": ""
                    }
                ],
                "setup": {
                    "currency": "JPY",
                    "insurance": 0,
                    "ref_number": "",
                    "delivery_note": "",
                    "discount": 0,
                    "pack_size": "60",
                    "pack_amount": 1,
                    "date": "2019-01-10",
                    "time": "16-18",
                    "care": {
                        "fragile": false,
                        "side_up": false,
                        "valuable_goods": false
                    },
                    "pick_up": false,
                    "print_start_location": "4"
                },
                "delivery": {
                    "carrier": "sagawa",
                    "method": "sagawa_regular",
                    "tracking_numbers": [
                        "514699818054"
                    ],
                    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/dJt72M3PhJQo9pmjE.pdf"
                }
            },
            {
                "id": "API-Q9CASGOIC9",
                "state": "active",
                "created_at": "2019-01-08T16:56:16.944Z",
                "to_address": {
                    "full_name": "太郎山田",
                    "address1": "京都市東山区",
                    "country": "JP",
                    "email": "yamada.taro@demo.com",
                    "phone": "08012341234",
                    "address2": "西海子町",
                    "address3": "神宮道",
                    "province": "京都府",
                    "zip": "6050012"
                },
                "from_address": {
                    "company": "株式会社ACME",
                    "address1": "中央区",
                    "country": "JP",
                    "email": "yamada.hanako@acme.com",
                    "phone": "08012341234",
                    "address2": "日本橋堀留町",
                    "address3": "タワー #1001",
                    "province": "東京都",
                    "zip": "1030012"
                },
                "products": [
                    {
                        "name": "Basket ball",
                        "quantity": 2,
                        "price": 4850,
                        "hs_code": ""
                    }
                ],
                "setup": {
                    "currency": "JPY",
                    "insurance": 0,
                    "ref_number": "",
                    "delivery_note": "",
                    "discount": 0,
                    "pack_size": "60",
                    "pack_amount": 1,
                    "date": "2019-01-10",
                    "time": "16-18",
                    "care": {
                        "fragile": false,
                        "side_up": false,
                        "valuable_goods": false
                    },
                    "pick_up": false,
                    "print_start_location": "4"
                },
                "delivery": {
                    "carrier": "sagawa",
                    "method": "sagawa_regular",
                    "tracking_numbers": [
                        "514699818043"
                    ],
                    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/74FBe7MnjmQ3eM66b.pdf"
                }
            },
            {
                "id": "API-6E53FMVTZF",
                "state": "active",
                "created_at": "2019-01-08T16:55:44.228Z",
                "to_address": {
                    "full_name": "太郎山田",
                    "address1": "京都市東山区",
                    "country": "JP",
                    "email": "yamada.taro@demo.com",
                    "phone": "08012341234",
                    "address2": "西海子町",
                    "address3": "神宮道",
                    "province": "京都府",
                    "zip": "6050012"
                },
                "from_address": {
                    "company": "株式会社ACME",
                    "address1": "中央区",
                    "country": "JP",
                    "email": "yamada.hanako@acme.com",
                    "phone": "08012341234",
                    "address2": "日本橋堀留町",
                    "address3": "タワー #1001",
                    "province": "東京都",
                    "zip": "1030012"
                },
                "products": [
                    {
                        "name": "Basket ball",
                        "quantity": 2,
                        "price": 4850,
                        "hs_code": ""
                    }
                ],
                "setup": {
                    "currency": "JPY",
                    "insurance": 0,
                    "ref_number": "",
                    "delivery_note": "",
                    "discount": 0,
                    "pack_size": "60",
                    "pack_amount": 1,
                    "date": "2019-01-10",
                    "time": "16-18",
                    "care": {
                        "fragile": false,
                        "side_up": false,
                        "valuable_goods": false
                    },
                    "pick_up": false,
                    "print_start_location": "4"
                },
                "delivery": {
                    "carrier": "sagawa",
                    "method": "sagawa_regular",
                    "tracking_numbers": [
                        "514699818032"
                    ],
                    "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/2GAfFX6Yy87cCtRqo.pdf"
                }
            }
        ],
        "count": 5,
        "pages": 1,
        "current_page": 1
    }
    

    作成した出荷情報を一覧表示します。

    リクエスト

    GET https://app.shipandco.com/api/v1/shipments

    項目 説明
    state 初期値 `active`, 指定可能な値: `active, voided, any`
    carrier 運送会社の`type`を指定します。運送会社の一覧で取得できるもの

    その他の項目はGETパラメータを参照してください。

    レスポンス

    作成した出荷情報の配列です。出荷情報の詳細は出荷情報の作成を参照してください。

    その他の項目はGETレスポンスを参照してください。

    出荷情報の取得

    curl -v -X GET "https://app.shipandco.com/api/v1/shipments/API-O8APFNW9S8" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "id": "API-O8APFNW9S8",
      "state": "active",
      "created_at": "2019-01-07T14:15:01.151Z",
      "to_address": {
        "full_name": "John Doe",
        "company": "ACME",
        "address1": "Rua Maria Matos, 32",
        "country": "PT",
        "email": "john@doe.io",
        "phone": "0901231234",
        "address2": "",
        "city": "CHARNECA DA CAPARICA",
        "province": "SETUBAL",
        "zip": "2820-344"
      },
      "from_address": {
        "full_name": "Yamada Taro",
        "company": "World Company",
        "address1": "OSAKAFU",
        "country": "JP",
        "email": "ytaro@worldcompany.com",
        "phone": "08012341234",
        "address2": "OTECHO",
        "city": "IBARAKI SHI",
        "province": "OSAKA",
        "zip": "5670883"
      },
      "products": [
        {
          "name": "Basket ball",
          "quantity": 2,
          "price": 4850,
          "hs_code": "HS9988",
          "hs_description": "Sports ball",
          "origin_country": "JP"
        }
      ],
      "parcels": [
        {
          "weight": 200,
          "amount": 1,
          "width": 10,
          "height": 10,
          "depth": 10
        }
      ],
      "customs": {
        "duty_paid": false,
        "content_type": "MERCHANDISE"
      },
      "setup": {
        "currency": "JPY",
        "insurance": 0,
        "ref_number": "",
        "delivery_note": "",
        "discount": 0,
        "return_label": false,
        "signature": false
      },
      "delivery": {
        "carrier": "japanpost",
        "method": "japanpost_ems",
        "tracking_numbers": ["EN027977320JP"],
        "label": "https://storage.googleapis.com/dev-shipandco/labels/201901/k3wWYYwk8Q8h46NcM/undefined.pdf"
      }
    }
    

    出荷情報をIDで取得します。

    リクエスト

    GET https://app.shipandco.com/api/v1/shipments/:id

    レスポンス

    1つの出荷情報を返します。出荷情報の詳細は出荷情報の作成を参照してください。

    出荷情報の削除

    curl -v -X DELETE "https://app.shipandco.com/api/v1/shipments/API-O8APFNW9S8" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    "Shipment API-O8APFNW9S8 deleted."
    

    出荷情報をIDで削除します。

    リクエスト

    DELETE https://app.shipandco.com/api/v1/shipments/:id

    レスポンス

    処理結果のメッセージが表示されます。

    料金

    料金の一覧

    curl -v -X POST "https://app.shipandco.com/api/v1/rates" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
        "to_address": {
          "full_name": "John Doe",
          "company": "ACME",
          "email": "john@doe.io",
          "phone": "0901231234",
          "country": "PT",
          "address1": "Rua Maria Matos, 32",
          "address2": "",
          "province": "SETUBAL",
          "zip": "2820-344",
          "city": "CHARNECA DA CAPARICA"
        },
        "from_address": {
          "full_name": "Yamada Taro",
          "company": "World Company",
          "email": "ytaro@worldcompany.com",
          "phone": "08012341234",
          "country": "JP",
          "address1": "OSAKAFU",
          "address2": "OTECHO",
          "province": "OSAKA",
          "zip": "5670883",
          "city": "IBARAKI SHI"
        },
        "products": [
          {
            "name": "Basket ball",
            "quantity": 2,
            "price": 4850,
            "hs_code": "HS9988",
            "hs_description": "Sports ball",
            "origin_country": "JP"
          }
        ],
        "parcels": [
          {
            "weight": 200,
            "amount": 1,
            "width": 10,
            "height": 10,
            "depth": 10
          }
        ],
        "customs": {
          "duty_paid": false,
          "content_type": "MERCHANDISE"
        },
        "setup": {
          "carrier": "japanpost",
          "currency": "JPY",
          "date": "2019-01-08",
          "insurance": 0,
          "ref_number": "",
          "delivery_note": "",
          "discount": 0,
          "signature": false
        }
    }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    [
      {
        "carrier": "japanpost",
        "service": "japanpost_ems",
        "currency": "JPY",
        "price": 2200,
        "surcharges": [
          {
           "type": "frozen",
           "amount": "324"
          }
        ]
      },
      {
        "carrier": "japanpost",
        "service": "japanpost_registered_mail",
        "currency": "JPY",
        "price": 690,
        "surcharges": []
      },
      {
        "carrier": "japanpost",
        "service": "japanpost_epacket",
        "currency": "JPY",
        "price": 785,
        "surcharges": []
      },
      {
        "carrier": "japanpost",
        "service": "japanpost_epacket_light",
        "currency": "JPY",
        "price": 620,
        "surcharges": []
      },
      {
        "carrier": "japanpost",
        "service": "airparcel",
        "currency": "JPY",
        "price": 2500,
        "surcharges": []
      },
      {
        "carrier": "japanpost",
        "service": "salparcel",
        "currency": "JPY",
        "price": 2700,
        "surcharges": []
      },
      {
        "carrier": "japanpost",
        "service": "seaparcel",
        "currency": "JPY",
        "price": 1800,
        "surcharges": []
      }
    ]
    

    作成する出荷情報を元に指定した運送会社のサービスごとの料金を一覧表示します。

    リクエスト

    POST https://app.shipandco.com/api/v1/rates

    `service`を除いた出荷情報の作成と同じです。詳細は、出荷情報の作成を参照してください。

    レスポンス

    各サービスの料金の配列です。詳細は、運送会社とサービスを参照してください。

    運送会社

    運送会社の登録

    curl -v -X POST "https://app.shipandco.com/api/v1/carriers" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
        "type": "dhl",
        "credentials": {
          "account_number": "123456789"
        },
        "settings": {
          "label": {
            "hide_account": true,
            "extra_page":  true
          }
        }
      }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "id": "g3buDjYMCXaj6zNCv",
      "type": "dhl",
      "state": "active",
      "created_at": "2019-02-25T11:58:57.852Z",
      "updated_at": "2019-02-25T11:58:57.852Z",
      "credentials": {
        "account_number": "*********"
     } 
    }
    

    運送会社を登録します。詳細は、弊社サイトを参照してください。

    リクエスト

    POST https://app.shipandco.com/api/v1/carriers

    項目 説明
    type 登録したい運送会社の種類。指定可能は値は`japanpost`、`ups`、`fedex`、`dhl`、`dhlecasia`、`sagawa`、`yamato`、`yuupack`、`pegasus`、`ecms`。
    credentials 運送会社のシステム利用に必要な認証情報です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。
    settings 運送会社の固有の設定です。内部のパラメータは各運送会社ごとに異なります。詳細は以下を参照ください。

    運送会社ごとの認証情報

    DHL

    account_number: 文字列、必須

    UPS

    account_number: 文字列、必須

    user_name: 文字列、必須

    password: 文字列、必須

    access_key: 文字列、必須

    FedEx

    account_number: 文字列、必須

    日本郵便 海外

    customer_numbers: 配列、最小長: 4、最大長: 4、必須(例:['000000000','000000000','000000000','000000000'])

    佐川急便

    account_number: 文字列、必須

    key: 文字列、必須

    password: 文字列、必須

    佐川急便からkeyとpasswordを入手するには申し込みフォームを埋めて佐川急便に提出する必要があります。5から8営業日で情報が送られアカウントは自動的に有効化されます。申し込みフォームへのリンクは近日公開予定です。

    日本郵便 国内(ゆうパック)

    user_id: 文字列、必須

    日本郵便からuser_idを入手するには申し込みフォームを埋めて日本郵便に提出する必要があります。5から8営業日で情報が送られます。申し込みフォームへのリンクは近日公開予定です。

    ヤマト運輸

    key: 文字列、必須

    freight_number: 文字列、(初期値:'01')

    ペガサス

    user_id: 文字列、必須

    password: 文字列、必須

    AUSTRALIA POST

    auspost_account_number: 文字列、必須

    startrack_account_number: 文字列、必須

    key: 文字列、必須

    secret: 文字列、必須

    DHL eCommerce Asia

    sold_to: 文字列、必須

    pick_up: 文字列、必須

    prefix: 文字列、必須

    ECMS

    merchant_id: 文字列、必須

    consumer_key: 文字列、必須

    consumer_secret: 文字列、必須

    運送会社ごとの設定

    DHL

    label.hide_account: ブーリアン型。ラベルにアカウント情報を表示するかどうか

    label.extra_page: ブーリアン型。アーカイブ用のページを作成するかどうか

    レスポンス

    登録された運送会社の情報をIDと共に表示します。

    運送会社の一覧

    curl -v -X GET "https://app.shipandco.com/api/v1/carriers" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    [
        {
            "id": "GZDZQNo7zyxr4sbXc",
            "type": "yuupacket",
            "state": "active",
            "created_at": "2019-01-07T14:24:13.045Z",
            "updated_at": "2019-01-07T14:24:13.045Z",
            "credentials": {
                "user_id": "***********"
            }
        },
        {
            "id": "FbqDPqcBL6AL7PwAo",
            "type": "yuupack",
            "state": "active",
            "created_at": "2019-01-07T14:24:13.042Z",
            "updated_at": "2019-01-07T14:24:13.042Z",
            "credentials": {
                "user_id": "***********"
            }
        },
        {
            "id": "7iuaQaEp8fasKCzgD",
            "type": "yamato",
            "state": "active",
            "created_at": "2019-01-07T14:06:13.197Z",
            "updated_at": "2019-01-07T14:06:13.197Z",
            "credentials": {
                "key": "*********************************************************",
                "freight_number": "**"
            }
        },
        {
            "id": "tbEuFScyfSQMx7bN8",
            "type": "sagawa",
            "state": "active",
            "created_at": "2019-01-07T14:06:39.627Z",
            "updated_at": "2019-01-07T14:08:45.817Z",
            "credentials": {
                "key": "********",
                "password": "************************",
                "account_number": "***********",
                "account_key_number": ""
            }
        },
        {
            "id": "CFjQRubN5jhhT5hTb",
            "type": "japanpost",
            "state": "active",
            "created_at": "2018-09-24T15:33:58.145Z",
            "updated_at": "2018-09-24T15:33:58.145Z",
            "credentials": {
                "customer_numbers": "****"
            }
        }
    ]
    

    登録されている運送会社の情報を一覧表示します。

    リクエスト

    GET https://app.shipandco.com/api/v1/carriers

    レスポンス

    登録されている運送会社の情報の配列です。

    運送会社の削除

    curl -v -X DELETE "https://app.shipandco.com/api/v1/carriers/GZDZQNo7zyxr4sbXc" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    "Carrier GZDZQNo7zyxr4sbXc deleted."
    

    運送会社をIDで削除します。

    リクエスト

    DELETE https://app.shipandco.com/api/v1/carriers/:id

    レスポンス

    処理結果のメッセージが表示されます。

    追跡情報

    追跡情報の取得

    curl -v -X GET "https://app.shipandco.com/api/v1/tracking/japanpost/RN004792035JP" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
        "requested_at": "2019-05-22T14:52:35.155Z",
        "carrier": "japanpost",
        "tracking_number": "RN004792035JP",
        "service": "Registered Mail / Insured Mail",
        "from_address": {},
        "to_address": {},
        "current_status": {
            "date": "2019-05-20T17:30:00.000Z",
            "status": "Arrival at outward office of exchange",
            "details": "",
            "location": "OSAKA"
        },
        "history": [
            {
                "date": "2019-05-20T07:45:00.000Z",
                "status": "Posting/Collection",
                "details": "",
                "location": "OSAKA"
            },
            {
                "date": "2019-05-20T17:30:00.000Z",
                "status": "Arrival at outward office of exchange",
                "details": "",
                "location": "OSAKA"
            }
        ]
    }
    

    追跡情報を運送会社と追跡番号を指定して取得します。

    リクエスト

    GET https://app.shipandco.com/api/v1/tracking/:carrier/:trackingNumber

    レスポンス

    運送会社の追跡情報です。

    住所

    住所の登録

    curl -v -X POST "https://app.shipandco.com/api/v1/addresses" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
       "full_name": "Ship Co",
       "company": "Ship&Co",
       "email": "shipco@shipandco.com",
       "phone": "0312345678",
       "country": "JP",
       "address1": "chukyo-ku",
       "address2": "",
       "address3": "",
       "province": "Kyoto-fu",
       "zip": "123-4567",
       "city": "Kyoto-shi"
    }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
        "id": "kr54qe8YPdc5HZSBu",
        "created_at": "2019-01-12T09:04:43.619Z",
        "updated_at": "2019-01-12T09:04:43.619Z",
        "address": {
            "full_name": "Ship Co",
            "company": "Ship&Co",
            "address1": "chukyo-ku",
            "address2": "",
            "address3": "",
            "city": "Kyoto-shi",
            "province": "Kyoto-fu",
            "zip": "123-4567",
            "country": "JP",
            "phone": "0312345678",
            "email": "shipco@shipandco.com"
        }
    }
    

    荷受人住所を登録します。

    リクエスト

    POST https://app.shipandco.com/api/v1/addresses

    登録する荷受人住所の情報です。詳細は、出荷情報の作成を参照してください。

    レスポンス

    登録された荷受人住所の情報をIDと共に表示します。

    住所の一覧

    curl -v -X GET "https://app.shipandco.com/api/v1/addresses" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    [
        {
            "id": "dC32vpNEja8W7WNwR",
            "created_at": "2019-01-12T08:32:55.411Z",
            "updated_at": "2019-01-12T08:32:55.411Z",
            "address": {
                "full_name": "John Doe",
                "company": "ACME",
                "address1": "Rua Maria Matos, 32",
                "address2": "",
                "address3": "",
                "city": "CHARNECA DA CAPARICA",
                "province": "SETUBAL",
                "zip": "2820-344",
                "country": "PT",
                "phone": "0901231234",
                "email": "john@doe.io"
            }
        },
        {
            "id": "kr54qe8YPdc5HZSBu",
            "created_at": "2019-01-12T09:04:43.619Z",
            "updated_at": "2019-01-12T09:04:43.619Z",
            "address": {
                "full_name": "Ship Co",
                "company": "Ship&Co",
                "address1": "chukyo-ku",
                "address2": "",
                "address3": "",
                "city": "Kyoto-shi",
                "province": "Kyoto-fu",
                "zip": "123-4567",
                "country": "JP",
                "phone": "0312345678",
                "email": "shipco@shipandco.com"
            }
        }
    ]
    

    登録されている荷受人住所の情報を一覧表示します。

    リクエスト

    GET https://app.shipandco.com/api/v1/addresses

    レスポンス

    登録されている荷受人住所の情報の配列です。

    倉庫

    倉庫の登録

    curl -v -X POST "https://app.shipandco.com/api/v1/warehouses" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
       "full_name": "",
       "full_name_kanji": "",
       "company": "ACME",
       "company_kanji": "株式会社ACME",
       "email": "",
       "phone": "090-1234-5678",
       "country": "JP",
       "address1": "HIGASHIYAMA KU",
       "address2": "SAIKAISHICHO",
       "province": "KYOTO",
       "address1_kanji": "京都市東山区",
       "address2_kanji": "西海子町",
       "address3_kanji": "",
       "province_kanji": "京都府",
       "zip": "604-0012",
       "city": "KYOTO SHI"
    }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
        "id": "cki5wYEHddBZuEtPv",
        "created_at": "2019-01-31T07:34:25.071Z",
        "updated_at": "2019-01-31T07:34:25.071Z",
        "address": {
            "full_name": "",
            "company": "ACME",
            "address1": "HIGASHIYAMA KU",
            "address2": "SAIKAISHICHO",
            "city": "KYOTO SHI",
            "province": "KYOTO",
            "zip": "604-0012",
            "country": "JP",
            "phone": "090-1234-5678",
            "email": "",
            "full_name_kanji": "",
            "company_kanji": "株式会社ACME",
            "address1_kanji": "京都市東山区",
            "address2_kanji": "西海子町",
            "address3_kanji": "",
            "province_kanji": "京都府"
        }
    }
    

    荷送人情報(倉庫)を登録します。

    リクエスト

    POST https://app.shipandco.com/api/v1/warehouses

    登録する荷送人情報です。

    レスポンス

    登録された荷送人情報をIDと共に表示します。

    倉庫の一覧

    curl -v -X GET "https://app.shipandco.com/api/v1/warehouses" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    [
        {
            "id": "cki5wYEHddBZuEtPv",
            "created_at": "2019-01-31T07:34:25.071Z",
            "updated_at": "2019-01-31T07:34:25.071Z",
            "address": {
                "full_name": "",
                "company": "ACME",
                "address1": "HIGASHIYAMA KU",
                "address2": "SAIKAISHICHO",
                "city": "KYOTO SHI",
                "province": "KYOTO",
                "zip": "604-0012",
                "country": "JP",
                "phone": "090-1234-5678",
                "email": "",
                "full_name_kanji": "",
                "company_kanji": "株式会社ACME",
                "address1_kanji": "京都市東山区",
                "address2_kanji": "西海子町",
                "address3_kanji": "",
                "province_kanji": "京都府"
            }
        },
        {
            "id": "phuAH6qFvoxdASoCr",
            "created_at": "2019-01-31T07:37:46.332Z",
            "updated_at": "2019-01-31T07:37:46.332Z",
            "address": {
                "full_name": "John Doe",
                "company": "ACME",
                "address1": "Rua Maria Matos, 32",
                "address2": "",
                "address3": "",
                "city": "CHARNECA DA CAPARICA",
                "province": "SETUBAL",
                "zip": "2820-344",
                "country": "PT",
                "phone": "0901231234",
                "email": "john@doe.io"
            }
        }
    ]
    

    登録されている荷送人情報を一覧表示します。

    リクエスト

    GET https://app.shipandco.com/api/v1/warehouses

    レスポンス

    登録されている荷送人情報の配列です。

    サブユーザー

    サブユーザーはShip&Coのダッシュボードで作成された正規アカウントに所属し、各自のトークンを持ってAPIをコールし、データを分離して管理できます。サブユーザーのAPI自体は正規アカウントのトークンしか使えません。

    サブユーザーの登録

    curl -v -X POST "https://app.shipandco.com/api/v1/sub-users" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json" \
      -d '{
        "contact": {
          "first_name": "John",
          "last_name": "Doe",
          "company": "ACME"
        },
        "email": "email@test.com",
        "api_token": true
    }'
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "id": "f1f97cfa813c828a73528989da671a81",
      "created_at": "2019-02-25T11:12:14.021Z",
      "email": "email@test.com",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
      "first_name": "John",
      "last_name": "Doe",
      "company": "ACME"
    }
    

    サブユーザーを登録します。

    リクエスト

    POST https://app.shipandco.com/api/v1/sub-users

    登録するサブユーザーの情報です。サブユーザーを作成するのはメールアドレスと最小限の連絡情報が必要です。

    項目 説明
    email 必須です。サブユーザーのキーとなります。
    contact first_name, last_name, full_name(任意), company
    api_token トークンを生成するかどうかです。

    レスポンス

    登録されたサブユーザーの情報をIDとAPIトークンと共に表示します。生成されたAPIトークンは他のAPIに利用できます。

    サブユーザーの一覧

    curl -v -X GET "https://app.shipandco.com/api/v1/sub-users" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    [
        {
            "id": "f1f97cfa813c828a73528989da671a81",
            "created_at": "2019-02-25T11:12:14.021Z",
            "email": "email@test.com",
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
            "first_name": "John",
            "last_name": "Doe",
            "company": "ACME"
        },
        {
            "id": "929ab359ada3fa5c7bf53bff7ffcbe58",
            "created_at": "2019-02-26T11:08:13.749Z",
            "email": "email2@test.com",
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjUzam9qand4ejlQdWZzRXp4IiwiaWF0IjoxNTUxMTc5MjkzfQ.RLb2jWjwo9FZwP3MSyyDYkbQZMTtmjMvTYql-dfgk1o",
            "first_name": "John 2",
            "last_name": "Doe 2",
            "company": "ACME 2"
        }
    ]
    

    登録されているサブユーザーを一覧表示します。

    リクエスト

    GET https://app.shipandco.com/api/v1/sub-users

    レスポンス

    登録されているサブユーザー情報の配列です。

    サブユーザーの取得

    curl -v -X GET "https://app.shipandco.com/api/v1/sub-users/f1f97cfa813c828a73528989da671a81" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "id": "f1f97cfa813c828a73528989da671a81",
      "created_at": "2019-02-25T11:12:14.021Z",
      "email": "email@test.com",
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMDkzMTM0fQ.gBUpoCpFbIt26DiezI4liHWel9KP47-p-Uw-Q3Ush6k",
      "first_name": "John",
      "last_name": "Doe",
      "company": "ACME"
    }
    

    サブユーザーをIDで取得します。

    リクエスト

    GET https://app.shipandco.com/api/v1/sub-users/:id

    レスポンス

    一つのサブユーザーを返します。

    サブユーザーの最新化

    curl -v -X POST "https://app.shipandco.com/api/v1/sub-users/f1f97cfa813c828a73528989da671a81" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVhYXNhZVBwNlpGWUZSZ1FzIiwiaWF0IjoxNTUxMTc5OTgyfQ.sQChZ4DjIPyDbgOmJ2-jUgMe_xw9d52-TBGizg9lPjo"
    }
    

    サブユーザーのAPIトークンを再生成します。

    リクエスト

    POST https://app.shipandco.com/api/v1/sub-users/:id

    レスポンス

    再生成されたAPIトークン

    サブユーザーの削除

    curl -v -X DELETE "https://app.shipandco.com/api/v1/sub-users/f1f97cfa813c828a73528989da671a81" \
      -H "x-access-token: YOUR_API_TOKEN_FROM_DASHBOARD" \
      -H "Content-Type: application/json"
    

    上記のリクエストは以下のようなレスポンスを返します。

    "Child user f1f97cfa813c828a73528989da671a81:email@test.com deleted."
    

    サブユーザーをIDで削除します。

    リクエスト

    DELETE https://app.shipandco.com/api/v1/sub-users/:id

    レスポンス

    処理結果のメッセージが表示されます。

    共通定義

    運送会社とサービス

    運送会社 サービスの値 海外 / 国内
    日本郵便 海外 japanpost japanpost_ems, japanpost_epacket, japanpost_epacket_light, japanpost_registered_mail, japanpost_air_parcel, japanpost_economy_air_parcel, japanpost_sea_parcel 海外
    日本郵便 国内(ゆうパック) yuupack yuupack_regular, yuupack_fresh, yuupack_frozen, regular 国内
    日本郵便 国内(ゆうパケット) yuupacket yuupacket_regular 国内
    UPS ups ups_saver, ups_worldwide_express, ups_worldwide_express_plus, ups_worldwide_expedited 海外
    DHL dhl dhl_express_worldwide, dhl_express_1200, dhl_express_0900, dhl_express_jumbo 海外
    DHL eCommerce Asia dhlecasia dhlec_asia_pps, dhlec_asia_pkd, dhlec_asia_ple, dhlec_asia_plt, dhlec_asia_pld, dhlec_asia_pkg 海外
    FedEx fedex fedex_international_economy, fedex_international_first, fedex_international_priority 海外
    佐川急便 sagawa sagawa_fresh, sagawa_frozen, sagawa_plane, sagawa_regular 国内
    ヤマト運輸 yamato yamato_regular, yamato_collect, yamato_direct_mail, yamato_time, yamato_freight_on_delivery, yamato_nekopos, yamato_taqbin, yamato_taqbin_collect 国内
    ペガサス pegasus pegasus_dhl, pegasus_ups, pegasus_ems 海外
    運送会社 荷物サイズの値 配達時間の値
    佐川急便 60, 80, 100, 140, 160 not-specified, before-noon, 12-14, 14-16, 16-18, 18-20, 19-21, 18-21
    日本郵便 国内(ゆうパック) 60, 80, 100, 120, 140, 160, 170 not-specified, before-noon, 12-14, 14-16, 16-18, 18-20, 19-21, 20-21
    ヤマト運輸 not-specified, before-noon, 14-16, 16-18, 18-20, 19-21
    項目 説明 海外 / 国内
    carrier 文字列。 出荷情報に使う運送会社の種類。指定可能は値は`japanpost`、`ups`、`fedex`、`dhl`、`dhlecasia`、`sagawa`、`yamato`、`yuupack`、`pegasus`。 海外, 国内
    service 文字列。 選択した運送会社のサービスの名称。上記リストの運送会社ごとの指定可能な値を参照。 海外, 国内
    currency 文字列。 出荷情報の通貨。ISO 4217の値のみ有効。 海外, 国内
    date 文字列。 出荷情報の日付。ISO 8601書式。例:`2018-09-20T00:00:00.000Z` 海外, 国内
    time 文字列。 運送会社依存の配達時間。`yamato`、`sagawa`、`yuupack`にのみ有効。上記リストを参照。 国内
    insurance 数値。 出荷情報と同じ通貨での保険金額。`japanpost`、`dhl`、`dhlecasia`、`ups`、`fedex`にのみ有効。※無保険にする場合は`0`を指定。 海外
    ref_number 文字列。 配送ラベルへの参照番号が必要な時に指定。 海外, 国内
    delivery_note 文字列。 配送に関するメモが必要な場合に指定。 海外, 国内
    signature ブーリアン型。 いくつかの運送会社の有料サービス。 海外
    cool_options 文字列。 指定可能な値は`regular`、`fresh`、`frozen`. 国内
    care オブジェクト。 `fragile`: (boolean), `side_up`: (boolean), `valuable_goods`: (boolean) 国内
    pack_size 文字列。 運送会社依存の荷物サイズ。上記リストを参照。 国内
    pack_amount 数値。 荷物の数量。 国内
    cash_on_delivery オブジェクト。 `amount`: (integer), `tax`: (integer) 国内
    return_label ブーリアン型。 返送用ラベルの同時発行。サポートしている運送会社(例:DHL)の場合に`true`を設定すると返送用ラベルのページも生成され追跡番号も複数できる。 海外, 国内
    print_start_location 数値。 A4ラベルの印刷開始ページ。`yuupacket_regular`、`yamato_direct_mail`、`yamato_nekopos`にのみ有効。 国内

    GETパラメータ

    項目 説明
    limit 初期値 `50`, 最大値 `250`
    page 初期値 `1`
    created_after 書式 `2018-09-20T00:00:00.000Z`
    created_before 初期値 `today` 書式 `2018-09-20T00:00:00.000Z`

    GETレスポンス

    項目 説明
    count データ数
    pages レスポンスのページ数(GETパラメータで指定可能)
    current_page レスポンスの現在ページ(GETパラメータで指定可能)

    呼び出し制限

    単位時間内のAPI呼び出しの数には制限があります。それを超えた場合は、`リクエスト数が多すぎます`のエラーが発生します。それを避けるために以下のレスポンスヘッダーの項目で制限の詳細を確認することができます。

    項目 説明
    x-api-call-limit APIの残りの呼び出し可能数/単位時間あたりの最大呼び出し可能数。呼び出し可能数が0になった後にAPIを呼び出すと上記のエラーが発生します
    x-api-call-reset 上記の残りの呼び出し可能数が最大呼び出し可能数にリセットされる日時

    エラー

    エラーコード

    Ship&Co APIには以下のエラーコードがあります。

    正常時には200を返します。

    エラーコード 説明
    400 不正な入力または入力不足によるエラー
    403 APIトークンが未指定か間違っています
    404 指定されたデータが見つかりません
    429 リクエスト数が多すぎます(詳細は呼び出し制限を参照してください)
    500 内部エラー

    エラーレスポンス

    {
      "debug_id": "err_8953pxowmMt3YW2XQ",
      "message": "INVALID",
      "description": "Request is not well-formed, syntactically incorrect, or violates schema.",
      "link": "https://developer.shipandco.com",
      "details": [
        {
          "field": "address1",
          "issue": "address1 is required"
        },
        {
          "field": "country",
          "issue": "country is required"
        }
      ],
    }
    

    Ship&Co APIは以下のようなエラーレスポンスを返します。

    項目 説明
    debug_id 各APIのコール毎に一意のIDでShip&Coと連絡を取るために使います
    message エラーの短い説明です
    description エラーの長い説明です
    link エラー情報へのリンクです
    details 各項目毎のエラー詳細です