ドキュメント

Create Exchange Order

POSThttps://your_server_address/orders

注文情報を作成します

ヘッダー

  • api_tokenstring必須

    認証用トークン

リクエストボディ

  • original_order_idstring必須

    元の注文 ID

  • order_discount_pricestring必須

    注文に対してのディスカウント (通常は 0 で Post します)

  • order_point_pricestring必須

    注文に対してのポイント利用 (通常は 0 で Post します)

  • total_item_discount_amountstring必須

    商品ディスカウント合計

  • subtotal_pricestring必須

    商品小計

  • total_shipping_pricestring必須

    注文時の送料 (通常は 0 で Post します)

  • total_discountstring必須

    ディスカウント合計(order_discount_amount+order_point_price+total_item_discount_amount)

  • total_pricestring必須

    合計金額

  • total_taxstring必須

    税

  • is_tax_includedboolean必須

    total_amount が税を含む金額か

  • currencystring必須

    通貨単位

  • line_itemsarray of objects必須

    注文商品

    子の属性を表示17
    • idinteger必須

      ラインアイテム ID

    • original_item_idstring必須

      元のラインアイテム ID

    • product_idstring必須

      商品 ID

    • product_namestring必須

      商品名

    • variant_idstring

      バリエーション ID

    • skustring必須

      SKU

    • item_imagestring必須

      商品画像

    • item_discount_pricestring必須

      商品に対してのディスカウント

    • item_discount_amountstring必須

      商品のディスカウント合計

    • item_pricestring必須

      商品の販売価格

    • item_compare_at_pricestring必須

      商品の定価

    • item_quantitystring必須

      商品の数量

    • item_price_amountstring必須

      商品の販売価格合計

    • item_tax_pricestring必須

      税

    • is_tax_includedboolean必須

      item_price_amount が税を含む金額か

    • fulfillment_statusstring必須

      発送状況 null: 未発送、fulfilled: 発送済み, partial: 一部発送済み, not_eligible: 発送対象外

      取りうる値: null fulfilled partial not_eligible

    • variant_optionsarray of objects

      バリエーションのオプション

      子の属性を表示2
      • namestring必須

        オプション名

      • valuestring必須

        オプションに設定されている値

  • shipping_addressobject必須

    配送住所

    子の属性を表示6
    • first_namestring

      名

    • last_namestring

      姓

    • full_namestring必須

      姓名

    • emailstring

      メールアドレス

    • phone_numberstring

      電話番号

    • addressobject必須

      住所情報

      子の属性を表示6
      • country_codestring

        国コード 日本の場合"JP" ISO-3166-2 参照

      • postal_codestring必須

        郵便番号

      • provincestring必須

        都道府県

      • citystring必須

        市区町村

      • address1string

        住所情報 1

      • address2string

        住所情報 2

  • billing_addressobject必須

    請求住所

    子の属性を表示6
    • first_namestring

      名

    • last_namestring

      姓

    • full_namestring必須

      姓名

    • emailstring

      メールアドレス

    • phone_numberstring

      電話番号

    • addressobject必須

      住所情報

      子の属性を表示6
      • country_codestring

        国コード 日本の場合"JP" ISO-3166-2 参照

      • postal_codestring必須

        郵便番号

      • provincestring必須

        都道府県

      • citystring必須

        市区町村

      • address1string

        住所情報 1

      • address2string

        住所情報 2

  • customerobject必須

    顧客情報

    子の属性を表示5
    • emailstring

      メールアドレス

    • last_namestringnull のことがある

      姓

    • first_namestringnull のことがある

      名

    • full_namestring

      姓名

    • phone_numberstring

      電話番号

  • recustomer_request_idstring必須

    Recustomer の返品リクエスト申請 ID

レスポンス

201 successfully.

  • idstring必須

    注文 ID

  • order_numberstring必須

    注文番号

  • statusstring必須

    注文ステータス processing: 処理中、fulfilled: 発送済み、partial_fulfilled: 一部発送済み、canceled: キャンセル済み

    取りうる値: processing fulfilled partial_fulfilled canceled

  • fulfillment_statusstring必須

    発送ステータス fulfilled: 発送済み、null: 未発送、partial: 一部発送済み、canceled: キャンセル済み

    取りうる値: fulfilled null partial canceled

  • financial_statusstring必須

    支払いステータス pending: 保留中、authorized: 認証済み、partially_paid: 一部支払い済み、paid: 支払い済み、partially_refunded: 一部返金済み、refunded: 返金済み、voided: 無効

    取りうる値: pending authorized partially_paid paid partially_refunded refunded voided

  • order_discount_amountstring

    注文に対してのディスカウント金額合計(モール利用の場合は、モール原資クーポン+店舗原資クーポン)

  • order_point_pricestring必須

    注文に対してのポイント利用

  • total_item_discount_amountstring必須

    商品ディスカウント合計

  • subtotal_pricestring必須

    商品小計

  • total_shipping_pricestring必須

    注文時の送料

  • total_discountstring必須

    ディスカウント合計(order_discount_amount+order_point_price+total_item_discount_amount)

  • additional_fees_amountstring

    その他費用合計

  • total_pricestring必須

    合計金額

  • total_taxstring必須

    税

  • payment_atstring

    入金日時

  • is_tax_includedboolean必須

    total_price が税を含む金額か

  • currencystring必須

    通貨単位

  • quantityinteger必須

    注文商品数の合計

  • created_atstring必須

    作成日時

  • updated_atstring

    更新日時

  • notestring

    注文の補足情報

  • customerobject必須

    顧客情報

    子の属性を表示12
    • customer_idstring

      カスタマー ID

    • emailstring必須

      メールアドレス

    • last_namestringnull のことがある

      姓

    • first_namestringnull のことがある

      名

    • full_namestring必須

      姓名

    • phone_numberstring

      電話番号

    • is_consent_email_marketingboolean

      email マーケティングに同意しているか

    • is_consent_sms_marketingboolean

      SMS マーケティングに同意しているか

    • purchase_timesinteger

      購入回数

    • customer_tagsarray of strings

      顧客タグ

    • created_atstring必須

      作成日時

    • updated_atstring必須

      更新日時

  • line_itemsarray of objects必須

    注文商品

    子の属性を表示19
    • idstring必須

      ラインアイテム ID

    • product_idstring必須

      商品 ID

    • product_namestring

      商品名

    • variant_idstring

      バリエーション ID

    • skustring必須

      SKU

    • item_imagestring

      商品画像

    • item_discount_pricestring必須

      商品に対してのディスカウント

    • item_discount_amountstring必須

      商品のディスカウント合計

    • item_pricestring必須

      商品の販売価格

    • item_compare_at_pricestring必須

      商品の定価

    • item_coststring

      注文時点での商品原価

    • item_quantitystring必須

      商品の数量

    • item_price_amountstring必須

      商品の販売価格合計

    • item_tax_pricestring必須

      税

    • is_tax_includedboolean必須

      item_price_amount が税を含む金額か

    • fulfillment_statusstring必須

      発送状況 null: 未発送、fulfilled: 発送済み, partial: 一部発送済み, not_eligible: 発送対象外

      取りうる値: null fulfilled partial not_eligible

    • variant_optionsarray of objects

      バリエーションのオプション

      子の属性を表示2
      • namestring必須

        オプション名

      • valuestring必須

        オプションに設定されている値

    • created_atstring必須

      作成日時

    • updated_atstring必須

      更新日時

  • shipping_addressobject必須

    配送住所

    子の属性を表示6
    • first_namestring

      名

    • last_namestring

      姓

    • full_namestring必須

      姓名

    • emailstring

      メールアドレス

    • phone_numberstring

      電話番号

    • addressobject必須

      住所情報

      子の属性を表示6
      • country_codestring

        国コード 日本の場合"JP" ISO-3166-2 参照

      • postal_codestring必須

        郵便番号

      • provincestring必須

        都道府県

      • citystring必須

        市区町村

      • address1string

        住所情報 1

      • address2string

        住所情報 2

  • billing_addressobject必須

    請求住所

    子の属性を表示6
    • first_namestring

      名

    • last_namestring

      姓

    • full_namestring必須

      姓名

    • emailstring

      メールアドレス

    • phone_numberstring

      電話番号

    • addressobject必須

      住所情報

      子の属性を表示6
      • country_codestring

        国コード 日本の場合"JP" ISO-3166-2 参照

      • postal_codestring必須

        郵便番号

      • provincestring必須

        都道府県

      • citystring必須

        市区町村

      • address1string

        住所情報 1

      • address2string

        住所情報 2

  • fulfillmentsarray of objects必須

    発送情報

    子の属性を表示7
    • idstring必須

      発送情報 ID

    • statusstring必須

      発送状況 pending: 保留中、open: 処理中、success: 処理成功、cancelled: キャンセル、failure: 処理失敗

      取りうる値: pending open success cancelled failure

    • tracking_companystring

      配送会社 yamato: ヤマト運輸、sagawa: 佐川集荷、jp: 日本郵便、askullogist: アスクルロジスト、seino_unyu: 西濃運輸、eco_hai: エコ配、global: 国際宅配便、others: その他

      取りうる値: yamato sagawa jp askullogist seino_unyu eco_hai global others

    • tracking_numberstring

      追跡番号

    • fulfillment_line_itemsarray of objects

      発送商品

      子の属性を表示3
      • idstring必須

        発送商品 ID

      • order_line_item_idinteger必須

        発送された商品の line_item_id

      • quantityinteger必須

        配送済みの商品数

    • created_atstring

      発送日時

    • updated_atstring

      更新日時

  • transactionsarray of objects

    料金情報 (支払いが完了している場合必須)

    子の属性を表示8
    • idstring必須

      トランザクション ID

    • parent_idinteger

      紐づく親トランザクション ID

    • amountstring必須

      取引金額

    • currencystring必須

      通貨単位 参考 (https://en.wikipedia.org/wiki/ISO_4217)

    • statusstring必須

      取引ステータス success: 成功、failure: 失敗、pending: 保留

      取りうる値: success failure pending

    • gatewaystring必須

      取引ゲートウェイ

    • created_atstring

      作成日時

    • updated_atstring

      更新日時

400 Bad request

  • messagestring

    エラー詳細が格納されます

401 Unauthorized

  • messagestring

    エラー詳細が格納されます

422 Unprocessable Entity

  • messagestring

    エラー詳細が格納されます

500 Internal Server Error

  • messagestring

    エラー詳細が格納されます (Recustomer にエラーが発生している可能性がございます。お手数ですがお問合せください)

© Recustomer, Inc.