0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Ship&co APIに「注文作成」エンドポイントが追加されました【2026年4月】

0
Posted at

Ship&co APIに「注文作成」エンドポイントが追加されました【2026年4月】

発送ラベル発行の前に「注文」を作れるようになりました

Ship&co APIに、待望の新エンドポイント 「注文の作成」 が追加されました。

これまでのShip&co APIでは、発送ラベルの作成(POST /v1/shipments)が中心でした。このエンドポイントでは、運送会社・サービス・発送日などをその場で確定してラベルを発行します。

新しい POST /v1/orders エンドポイントは、運送会社を決める前に注文データだけを先にShip&coに登録できる仕組みです。

こんな場面で特に有効です:

  • WMS・ERPなど独自システムとShip&coを連携し、Ship&coのUIから出荷ラベルを発行したい
  • ShopifyやAmazonなどの標準的なカートシステムを使用していない
  • 複数チャネルの注文を一元管理し、Ship&coで柔軟に発送処理を行いたい
  • 注文受付のタイミングと、ラベル発行のタイミングを分けて管理したい

📖 公式APIドキュメント(注文の作成):https://developer.shipandco.com/order-create


エンドポイント概要

項目 内容
作成 POST https://api.shipandco.com/v1/orders
一覧取得 GET https://api.shipandco.com/v1/orders
削除 DELETE https://api.shipandco.com/v1/orders/:id
認証 リクエストヘッダー x-access-token: YOUR_API_TOKEN

作成された注文には API-ABCDE12345 のような識別子が自動的に付与されます。注文一覧は直近2週間分が返され、それ以上前のデータは created_after / created_before パラメータで指定できます(最大2ヶ月前まで)。


注文作成に必要な最小パラメータ

フィールド 必須
setup.currency
to_address.country
to_address.zip
to_address.phone
to_address.full_name または to_address.company(どちらか1つ)
to_address.address1
products.name
products.quantity
products.price
setup.currency

運送会社(carrier)の指定は任意です。 注文作成時点では決めず、あとでShip&coアプリから出荷時に設定できます。


コード例

最小パラメータを用いた国内注文

curl -X POST https://api.shipandco.com/v1/orders \
  -H "x-access-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to_address": {
      "full_name": "山田太郎",
      "phone": "03-1234-5678",
      "country": "JP",
      "zip": "150-0041",
      "province": "東京都",
      "address1": "渋谷区神南1-2-3"
    },
    "products": [
      {
        "name": "抹茶ギフトセット",
        "quantity": 1,
        "price": 3500
      }
    ],
    "setup": {
      "currency": "JPY"
    }
  }'

海外向け注文(日本 → フランスの例)

海外向けの注文では、通関処理のために customs オブジェクトと、商品ごとの hs_codeweightorigin_country などが必要です。

curl -X POST https://api.shipandco.com/v1/orders \
  -H "x-access-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "to_address": {
    "full_name": "Jean Dupont",
    "company": "ACME France",
    "email": "jean@example.com",
    "phone": "0612345678",
    "country": "FR",
    "zip": "75002",
    "city": "Paris",
    "address1": "25 Rue de la Paix"
  },
  "products": [
    {
      "name": "Bento Box Sakura Edition",
      "quantity": 2,
      "price": 3500,
      "hs_code": "392410",
      "hs_description": "Plastics; tableware and kitchenware",
      "weight": 350,
      "origin_country": "JP"
    },
    {
      "name": "Bento Box Sakura Edition 2",
      "quantity": 2,
      "price": 3000,
      "hs_code": "392410",
      "hs_description": "Plastics; tableware and kitchenware",
      "weight": 300,
      "origin_country": "JP"
    }
  ],
  "parcels": [
    {
      "amount": 1,
      "width": 30,
      "height": 20,
      "depth": 15,
      "weight": 2000,
      "type": "custom"
    }
  ],
  "customs": {
    "content_type": "MERCHANDISE",
    "duty_paid": false
  },
  "setup": {
    "currency": "JPY",
    "ref_number": "ORDER-FR-001"
  }
}'

国内 vs 海外向け:主なパラメータの違い

項目 国内注文 海外向け注文
customs オブジェクト 不要 送り状作成時に必須content_typeduty_paid
products.hs_code 不要 推奨(通関処理に必要)
products.weight 不要 推奨
products.origin_country 不要 送り状作成時に必須(通関処理に必要)
setup の追加オプション例 carriershipment_datecash_on_deliverycool_options signatureinsuranceconsignee_tax_id

注意点・補足

  • 海外向けの注文作成時にref_numberを使うと、出荷ラベル作成の際に、自社の管理システムの注文IDなどと紐付けができます。
  • 国内注文(日本郵便ゆうパックまたは佐川急便)において運送会社の規定サイズ を指定する際は setup.pack_size に以下のいずれかを指定してください。
    • ゆうパック:60, 80, 100, 120, 140, 160, 170
    • 佐川急便:60, 80, 100, 140, 160
  • 作成された注文は Ship&coアプリのUIから確認・編集・出荷処理が可能です。APIとアプリを組み合わせた運用にも対応しています。

よくある質問

Q. 注文作成と出荷情報作成(/v1/shipments)は何が違うの?
/v1/shipments は運送会社・サービス・出荷日を指定してその場でラベルを発行します。/v1/orders は注文データだけを先に登録し、ラベル発行は後から行います。受注データの作成と出荷のタイミングが異なるオペレーションに最適です。

Q. 作成した注文をあとから修正できますか?
Ship&coアプリのUIから編集できます。APIからの更新には現時点で対応しておりません。

Q. 作成した注文データはAPIで取得できますか?
注文の一覧取得APIを使って、初期値として直近2週間以内に作成された分が返されます(created_after / created_before で最大2ヶ月前まで指定可能)。既に送り状が発行されたデータは、返却されません。


まとめ

ポイント 内容
新エンドポイント POST /v1/orders
何ができる 運送会社未定のまま注文データをShip&coに登録
向いているケース WMS/ERP連携、独自カートシステム、複数チャネル管理
運送会社の指定 任意(あとから設定可)
海外向け注文 customs + 商品ごとの hs_code / weight / origin_country 等が必要

Ship&co APIを試してみる
→ アカウント登録(30日間無料トライアル):https://app.shipandco.com/join
→ APIドキュメント:https://developer.shipandco.com
→ Postmanコレクション:https://postman.shipandco.com
→ 導入事例のご紹介:https://www.shipandco.com/ja/api#cases

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?