Docs

Import Order

View as Markdownllms.txt

POSThttps://public.rcmr.io/api/v1/orders/import

Sends order information to Recustomer.

Headers

  • Authorizationstringrequired

    API token issued on the "Custom Integration" screen under "Integrations" in the admin console. Send it with the Bearer scheme

Request body

  • idstringrequired

    Order ID

  • order_numberstringrequired

    Order number

  • statusstringrequired

    Order status. processing: in progress, fulfilled: shipped, partial_fulfilled: partially shipped, canceled: cancelled

    Possible values: processing fulfilled partial_fulfilled canceled

  • fulfillment_statusstringrequired

    Fulfillment status. fulfilled: shipped, null: not shipped, partial: partially shipped, canceled: cancelled

    Possible values: fulfilled null partial canceled

  • financial_statusstringrequired

    Payment status. pending: pending, authorized: authorized, partially_paid: partially paid, paid: paid, partially_refunded: partially refunded, refunded: refunded, voided: voided

    Possible values: pending authorized partially_paid paid partially_refunded refunded voided

  • order_discount_amountstring

    Total discount on the order (for marketplaces, marketplace-funded coupons plus store-funded coupons)

  • order_point_pricestringrequired

    Points used on the order

  • total_item_discount_amountstringrequired

    Total item discounts

  • subtotal_pricestringrequired

    Item subtotal

  • total_shipping_pricestringrequired

    Shipping fee at the time of the order

  • total_discountstringrequired

    Total discount (order_discount_amount + order_point_price + total_item_discount_amount)

  • additional_fees_amountstring

    Total of other fees

  • total_pricestringrequired

    Total price

  • total_taxstringrequired

    Tax

  • payment_atstring

    Paid at

  • is_tax_includedbooleanrequired

    Whether total_price includes tax

  • currencystringrequired

    Currency

  • quantityintegerrequired

    Total quantity of ordered items

  • created_atstringrequired

    Ordered at

  • updated_atstring

    Updated at

  • notestring

    Note on the order

  • order_linkstring

    Link to the order

  • customerobjectrequired

    Customer information

    Show child attributes13
    • customer_idstring

      Customer ID

    • emailstringrequired

      Email address

    • last_namestringnullable

      Last name

    • first_namestringnullable

      First name

    • full_namestringrequired

      Full name

    • phone_numberstring

      Phone number

    • is_consent_email_marketingboolean

      Whether the customer accepts email marketing

    • is_consent_sms_marketingboolean

      Whether the customer accepts SMS marketing

    • purchase_timesinteger

      Number of orders

    • customer_tagsarray of strings

      Customer tags

    • created_atstringrequired

      Created at

    • updated_atstringrequired

      Updated at

    • metafieldsarray of objects

      Custom fields you want to set

      Show child attributes2
      • keystringrequired

        Metafield key

      • valueanyrequired

        Value for the metafield key

  • line_itemsarray of objectsrequired

    Ordered items

    Show child attributes20
    • idstringrequired

      Line item ID

    • product_idstringrequired

      Product ID

    • product_namestringrequired

      Product name

    • variant_idstring

      Variant ID

    • skustringrequired

      SKU

    • item_imagestringrequired

      Product image

    • item_discount_pricestringrequired

      Discount on the item

    • item_discount_amountstringrequired

      Total discount on the item

    • item_pricestringrequired

      Selling price of the item

    • item_compare_at_pricestringrequired

      List price of the item

    • item_coststring

      Cost of the item at the time of the order

    • item_quantitystringrequired

      Quantity of the item

    • item_price_amountstringrequired

      Total selling price of the item

    • item_tax_pricestringrequired

      Tax

    • is_tax_includedbooleanrequired

      Whether item_price_amount includes tax

    • fulfillment_statusstringrequired

      Fulfillment status. null: not shipped, fulfilled: shipped, partial: partially shipped, not_eligible: not subject to shipping

      Possible values: null fulfilled partial not_eligible

    • variant_optionsarray of objects

      Variant options

      Show child attributes2
      • namestringrequired

        Option name

      • valuestringrequired

        Value set for the option

    • created_atstringrequired

      Created at

    • updated_atstringrequired

      Updated at

    • metafieldsarray of objects

      Custom fields you want to set

      Show child attributes2
      • keystringrequired

        Metafield key

      • valueanyrequired

        Value for the metafield key

  • shipping_addressobjectrequired

    Shipping address

    Show child attributes6
    • first_namestring

      First name

    • last_namestring

      Last name

    • full_namestringrequired

      Full name

    • emailstring

      Email address

    • phone_numberstring

      Phone number

    • addressobjectrequired

      Address

      Show child attributes6
      • country_codestring

        Country code, "JP" for Japan. See ISO-3166-2

      • postal_codestringrequired

        Postal code

      • provincestringrequired

        Prefecture

      • citystringrequired

        City

      • address1string

        Address line 1

      • address2string

        Address line 2

  • billing_addressobjectrequired

    Billing address

    Show child attributes6
    • first_namestring

      First name

    • last_namestring

      Last name

    • full_namestringrequired

      Full name

    • emailstring

      Email address

    • phone_numberstring

      Phone number

    • addressobjectrequired

      Address

      Show child attributes6
      • country_codestring

        Country code, "JP" for Japan. See ISO-3166-2

      • postal_codestringrequired

        Postal code

      • provincestringrequired

        Prefecture

      • citystringrequired

        City

      • address1string

        Address line 1

      • address2string

        Address line 2

  • fulfillmentsarray of objectsrequired

    Fulfillments

    Show child attributes7
    • idstringrequired

      Fulfillment ID

    • statusstringrequired

      Fulfillment status. pending: pending, open: in progress, success: succeeded, cancelled: cancelled, failure: failed

      Possible values: pending open success cancelled failure

    • tracking_companystring

      Carrier. yamato: Yamato Transport, sagawa: Sagawa Express, jp: Japan Post, askullogist: ASKUL LOGIST, seino_unyu: Seino Transportation, eco_hai: Ecohai, global: international express, others: other

      Possible values: yamato sagawa jp askullogist seino_unyu eco_hai global others

    • tracking_numberstring

      Tracking number

    • fulfillment_line_itemsarray of objects

      Fulfilled items

      Show child attributes3
      • idstringrequired

        Fulfilled item ID

      • order_line_item_idintegerrequired

        line_item_id of the shipped item

      • quantityintegerrequired

        Number of items shipped

    • created_atstring

      Shipped at

    • updated_atstring

      Updated at

  • transactionsarray of objects

    Payment information (required if payment is complete)

    Show child attributes8
    • idstringrequired

      Transaction ID

    • parent_idinteger

      ID of the parent transaction

    • amountstringrequired

      Transaction amount

    • currencystringrequired

      Currency. See https://en.wikipedia.org/wiki/ISO_4217

    • statusstringrequired

      Transaction status. success: succeeded, failure: failed, pending: pending

      Possible values: success failure pending

    • gatewaystringrequired

      Payment gateway

    • created_atstring

      Created at

    • updated_atstring

      Updated at

  • metafieldsarray of objects

    Custom fields you want to set

    Show child attributes2
    • keystringrequired

      Metafield key

    • valueanyrequired

      Value for the metafield key

Responses

201 successfully.

  • resultsstring

400 Bad request

  • messagestring

    Error details

401 Unauthorized

  • messagestring

    Error details

403 The API token does not have the "Import orders" (orders:import) permission, or orders cannot be imported for the store of the API token

  • messagestring

    Error details

422 Unprocessable Entity

  • messagestring

    Error details

500 Internal Server Error

  • messagestring

    Error details (an error may have occurred in Recustomer. Please contact us)

503 The API token cannot be verified right now. Retry later

  • messagestring

    Error details

© Recustomer, Inc.