POST:orders/create_imported.json

Description

Create an imported order.

Permission bit: "orders.create"

Topic: Orders

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Array of OIOrder

Copy
[
  {
    "billing_address": {
      "address1": "Chestnut Street 92",
      "address2": "Apartment 2",
      "city": "Louisville",
      "company": "Google inc.",
      "country": "US",
      "id": "ad_EQzGqWoY",
      "name": "John Smith",
      "phone": "5556251199",
      "plus_code": "PQ7W+WM",
      "province": "KY",
      "zip": "40202"
    },
    "billing_address_short_id": "",
    "cancel_reason": "customer",
    "canceled_at": "",
    "coupon_id": "",
    "created_at": "",
    "currency": "",
    "custom_items": [
      {
        "grams": 5,
        "height": 5,
        "inventory_location_id": "",
        "length": 5,
        "physical": true,
        "price": 5,
        "tax_class": "",
        "taxable": true,
        "title": "",
        "width": 5
      }
    ],
    "customer_balance_spent": 5,
    "customer_id": "",
    "financial_status": "authorized",
    "fulfilled_at": "",
    "fulfillment_status": "fulfilled",
    "fulfillments": [
      {
        "canceled_at": "",
        "created_at": "",
        "digital": true,
        "disabled_at": "",
        "email": true,
        "expected_at_max": "",
        "expected_at_min": "",
        "line_items": [
          {
            "dest_inventory_location_id": "",
            "inventory_location_id": "",
            "line_item_index": 5,
            "quantity": 5,
            "returned": 5,
            "variant_id": ""
          }
        ],
        "pickup_inventory_location_id": "",
        "shipping_provider_type": "auspost",
        "tracking_company": "",
        "tracking_events": [
          {
            "city": "",
            "code": "",
            "country": "",
            "created_at": "",
            "description": "",
            "is_new": true,
            "province": "",
            "received_at": "",
            "status": "attempt_fail",
            "zip": ""
          }
        ],
        "tracking_number": "",
        "tracking_url": "",
        "updated_at": ""
      }
    ],
    "history": [
      {
        "action": "abandon",
        "authorize_transaction": {
          "amount": 5,
          "external_id": "",
          "gateway_token": "",
          "test": true,
          "token": ""
        },
        "cancel": {},
        "capture_transaction": {
          "amount": 5,
          "external_id": "",
          "gateway_token": "",
          "test": true,
          "token": ""
        },
        "created_at": "",
        "customer_id": "",
        "fulfillment_canceled": {
          "fulfillment_index": 5
        },
        "fulfillment_completed": {
          "fulfillment_index": 5
        },
        "fulfillment_created": {
          "fulfillment_index": 5
        },
        "fulfillment_modified": {
          "changes": [
            {
              "from": "",
              "name": "",
              "to": ""
            }
          ],
          "fulfillment_index": 5
        },
        "manual_payment": {
          "amount": 5
        },
        "manual_refund": {
          "amount": 5,
          "customer_balance": 5,
          "fee": 5,
          "line_items": [
            {
              "amount": 5,
              "fee": 5,
              "line_item_index": 5,
              "quantity": 5,
              "variant_id": ""
            }
          ],
          "refund_reason": "adjustment",
          "reported_amount": 5
        },
        "refund_transaction": {
          "amount": 5,
          "customer_balance": 5,
          "external_id": "",
          "fee": 5,
          "gateway_token": "",
          "line_items": [
            null
          ],
          "token": ""
        },
        "restock": {
          "line_items": [
            {
              "dest_inventory_location_id": "",
              "fulfillment_index": 5,
              "inventory_location_id": "",
              "line_item_index": 5,
              "quantity": 5,
              "variant_id": ""
            }
          ]
        },
        "user_id": ""
      }
    ],
    "line_items": [
      {
        "custom_item_index": {
          "value": 5
        },
        "detail": {
          "bundle_items": [
            {
              "managed": true,
              "product_id": "",
              "quantity_per_bundle": 5,
              "type": "bundle",
              "variant_id": ""
            }
          ],
          "discount": 5,
          "discount_rule_name": "",
          "discount_tax": 5,
          "inventory": [
            {
              "fulfillable_quantity": 5,
              "inventory_location_id": "",
              "quantity": 5,
              "variant_id": ""
            }
          ],
          "managed": true,
          "original_price": 5,
          "price": 5,
          "price_source": "",
          "tax": {
            "city_tax": 5,
            "city_tax_is_compound": true,
            "city_tax_name": "",
            "city_tax_rate": 3.1415,
            "country": "",
            "country_tax": 5,
            "country_tax_name": "",
            "country_tax_rate": 3.1415,
            "county_tax": 5,
            "county_tax_is_compound": true,
            "county_tax_name": "",
            "county_tax_rate": 3.1415,
            "name": "",
            "province": "",
            "province_tax": 5,
            "province_tax_is_compound": true,
            "province_tax_name": "",
            "province_tax_rate": 3.1415,
            "shipping_tax_class": "",
            "shipping_tax_method": "custom",
            "special_tax": 5,
            "special_tax_is_compound": true,
            "special_tax_name": "",
            "special_tax_rate": 3.1415,
            "tax_rounding": 5
          },
          "tax_excl_price": 5,
          "tax_incl_price": 5
        },
        "quantity": 5,
        "variant_id": ""
      }
    ],
    "mobile": "",
    "mobile_notifications": true,
    "number": 5,
    "paid_at": "",
    "payment_detail": {
      "card": {
        "address_line1_check": "",
        "address_postal_code_check": "",
        "avs_result_code": "",
        "bin": "",
        "company": "amex",
        "country": "",
        "cvc_check": "",
        "cvv_result_code": "",
        "exp_month": 5,
        "exp_year": 5,
        "fingerprint": "",
        "funding": "credit",
        "last4": ""
      },
      "client": {
        "accept_language": "",
        "browser_ip": "",
        "ip_and_ua": {
          "br_family": "",
          "br_version": "",
          "dvce_brand": "",
          "dvce_family": "",
          "dvce_model": "",
          "geo_accuracy_radius": 5,
          "geo_city": "",
          "geo_continent": "",
          "geo_continent_name": "",
          "geo_country": "",
          "geo_country_name": "",
          "geo_latitude": 3.1415,
          "geo_longitude": 3.1415,
          "geo_metro_code": 5,
          "geo_region": "",
          "geo_region_name": "",
          "geo_timezone": "",
          "geo_zipcode": "",
          "ip_domain": "",
          "ip_isanonymousproxy": true,
          "ip_isp": "",
          "ip_issatelliteprovider": true,
          "ip_netspeed": "",
          "ip_organization": "",
          "os_family": "",
          "os_version": ""
        },
        "session_id": "",
        "user_agent": ""
      },
      "failed_attempts": 5,
      "payment_method_id": "",
      "type": "alipay"
    },
    "primary_rate": 3.1415,
    "promotion_id": "",
    "recovered": true,
    "reserved_at": "",
    "restored_at": "",
    "round_tax_at": "jurisdiction",
    "sales_channel_id": "",
    "shipping_address_short_id": "",
    "shipping_detail": {
      "discount": 5,
      "discount_rule_name": "",
      "discount_tax": 5,
      "price": 5,
      "tax_excl_price": 5,
      "tax_incl_price": 5,
      "title": ""
    },
    "shipping_price": 5,
    "source_name": "admin",
    "subtotal_price": 5,
    "tags": [
      ""
    ],
    "tax_inclusive_prices": true,
    "tax_rounding": 5,
    "total_discounts": 5,
    "total_line_items_price": 5,
    "total_price": 5,
    "total_tax": 5,
    "total_weight": 5,
    "usd_rate": 3.1415
  }
]

Response Body

Array of Order

Response Body Type

Loading module