Upsert Order

Upsert an order using the external_id.

PUT /orders

Upsert Order

cURL

curl --request PUT \
  --url https://api.loopreturns.com/api/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "name": "<string>",
  "status": "active",
  "external_id": "<string>",
  "channel": "<string>",
  "customer": {
    "id": 123
  },
  "taxes_included": true,
  "total_price_presentment": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "total_discounts": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "total_discounts_presentment": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "total_taxes": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "total_taxes_presentment": {
    "amount": 50000,
    "currency_code": "USD"
  },
  "order_discounts": [
    [
      {
        "external_id": "<string>",
        "name": "<string>",
        "discount_type": "amount",
        "code": "<string>",
        "reason": "<string>",
        "rate": 123
      }
    ]
  ],
  "shipping_lines": [
    {
      "title": "<string>",
      "discounts": {
        "external_id": "<string>",
        "name": "<string>",
        "discount_type": "amount",
        "code": "<string>",
        "reason": "<string>",
        "rate": 123
      },
      "tax_lines": [
        {
          "title": "<string>",
          "rate": 123
        }
      ]
    }
  ],
  "refunds": [
    [
      {
        "external_id": "<string>",
        "type": "line_item",
        "line_item": [
          {
            "id": 123,
            "quantity": 123,
            "restock": true
          }
        ],
        "created_at": "2023-04-25T13:25:00-05:00",
        "updated_at": "2023-04-25T13:25:00-05:00"
      }
    ]
  ],
  "line_items": [
    {
      "external_id": "<string>",
      "product": {
        "id": 123
      },
      "product_variant": {
        "id": 123
      },
      "quantity": 123,
      "unit_price_presentment": {
        "amount": 50000,
        "currency_code": "USD"
      },
      "unit_discounts": {
        "amount": 50000,
        "currency_code": "USD"
      },
      "unit_discounts_presentment": {
        "amount": 50000,
        "currency_code": "USD"
      },
      "taxable": true,
      "tax_lines": [
        {
          "title": "<string>",
          "rate": 123
        }
      ],
      "refunds": [
        {
          "external_id": "<string>",
          "type": "line_item",
          "line_item": [
            {
              "id": 123,
              "quantity": 123,
              "restock": true
            }
          ],
          "created_at": "2023-04-25T13:25:00-05:00",
          "updated_at": "2023-04-25T13:25:00-05:00"
        }
      ],
      "discounts": [
        {
          "external_id": "<string>",
          "discount_type": "amount",
          "discount_relation": "prereq",
          "name": "<string>",
          "code": "<string>",
          "reason": "<string>",
          "rate": 123
        }
      ],
      "duties": [
        {
          "hs_code": "<string>",
          "country_of_origin": "<string>",
          "tax_lines": [
            {
              "title": "<string>",
              "rate": 123
            }
          ]
        }
      ]
    }
  ],
  "fulfillments": [
    {
      "external_id": "<string>",
      "status": "success",
      "fulfilled_at": "2023-11-07T05:31:56Z",
      "shipping_carrier": "<string>",
      "location": {
        "id": 123
      },
      "fulfillment_line_items": [
        {
          "external_id": "<string>",
          "order_line_item_external_id": "<string>",
          "quantity": 123
        }
      ],
      "tracking_numbers": [
        "<string>"
      ]
    }
  ],
  "source": "<string>",
  "tags": [
    "<string>"
  ],
  "created_at": "2023-04-25T13:25:00-05:00",
  "updated_at": "2023-04-25T13:25:00-05:00"
}
'

200

{
  "order": {
    "id": 2,
    "external_id": "<string>",
    "name": "<string>",
    "source": "<string>",
    "channel": {
      "id": 123,
      "name": "<string>"
    },
    "customer": {
      "id": 123,
      "external_id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    },
    "status": "active",
    "taxes_included": true,
    "shipping_lines": [
      {
        "title": "<string>",
        "discounts": {
          "external_id": "<string>",
          "name": "<string>",
          "discount_type": "amount",
          "code": "<string>",
          "reason": "<string>",
          "rate": 123
        },
        "tax_lines": [
          {
            "title": "<string>",
            "rate": 123
          }
        ]
      }
    ],
    "order_discounts": [
      {
        "external_id": "<string>",
        "name": "<string>",
        "discount_type": "amount",
        "code": "<string>",
        "reason": "<string>",
        "rate": 123
      }
    ],
    "tags": [
      "<string>"
    ],
    "refunds": [
      [
        [
          {
            "external_id": "<string>",
            "type": "line_item",
            "line_item": [
              {
                "id": 123,
                "quantity": 123,
                "restock": true
              }
            ],
            "created_at": "2023-04-25T13:25:00-05:00",
            "updated_at": "2023-04-25T13:25:00-05:00"
          }
        ]
      ]
    ],
    "line_items": [
      {
        "id": 2,
        "external_id": "<string>",
        "product": {
          "id": 123
        },
        "product_variant": {
          "id": 123
        },
        "quantity": 123,
        "unit_price_presentment": {
          "amount": 50000,
          "currency_code": "USD"
        },
        "unit_discounts": {
          "amount": 50000,
          "currency_code": "USD"
        },
        "unit_discounts_presentment": {
          "amount": 50000,
          "currency_code": "USD"
        },
        "taxable": true,
        "tax_lines": [
          {
            "title": "<string>",
            "rate": 123
          }
        ],
        "refunds": [
          {
            "external_id": "<string>",
            "type": "line_item",
            "line_item": [
              {
                "id": 123,
                "quantity": 123,
                "restock": true
              }
            ],
            "created_at": "2023-04-25T13:25:00-05:00",
            "updated_at": "2023-04-25T13:25:00-05:00"
          }
        ],
        "discounts": [
          {
            "external_id": "<string>",
            "discount_type": "amount",
            "discount_relation": "prereq",
            "name": "<string>",
            "code": "<string>",
            "reason": "<string>",
            "rate": 123
          }
        ],
        "duties": [
          {
            "hs_code": "<string>",
            "country_of_origin": "<string>",
            "tax_lines": [
              {
                "title": "<string>",
                "rate": 123
              }
            ]
          }
        ]
      }
    ],
    "fulfillments": [
      {
        "external_id": "<string>",
        "status": "success",
        "fulfilled_at": "2023-11-07T05:31:56Z",
        "shipping_carrier": "<string>",
        "location": {
          "id": 123
        },
        "fulfillment_line_items": [
          {
            "external_id": "<string>",
            "order_line_item_external_id": "<string>",
            "quantity": 123
          }
        ],
        "tracking_numbers": [
          "<string>"
        ]
      }
    ],
    "created_at": "2023-04-25T13:25:00-05:00",
    "updated_at": "2023-04-25T13:25:00-05:00"
  }
}

Authorizations

X-Authorization · string · header · required

API Scope: "Order (write)"

Body

application/json

name · string · required

The name of the order.

Maximum string length: 100

status · enum<string> · required

Status of the Order.

Available options: active, archived, cancelled, unknown

external_id · string

External ID of the order.

Maximum string length: 100

Example:

"564400c7-7a6b-4f29-b6a5-7bb580b2992c"

channel · string | null

If a channel with this name is not already associated with the shop, it will be used to create a new channel.

Maximum string length: 64

Example:

"shopify"

customer · object

Option 1

Option 2

Show child attributes

shipping_address · object

Show child attributes

Example:

{
  "name": "John Smith",
  "company": "Acme, Co",
  "address1": "123 Example St",
  "address2": "Box 123",
  "city": "Columbus",
  "region": "OH",
  "postal_code": 12345,
  "country_code": "US"
}

billing_address · object

Show child attributes

Example:

{
  "name": "John Smith",
  "company": "Acme, Co",
  "address1": "123 Example St",
  "address2": "Box 123",
  "city": "Columbus",
  "region": "OH",
  "postal_code": 12345,
  "country_code": "US"
}

taxes_included · boolean

total_price · object

The price of the order in minor units, such as cents, with its corresponding currency.

Show child attributes

Examples:

{ "amount": 50000, "currency_code": "USD" }

{ "amount": 25000 }

{ "amount": 1500, "currency_code": "EUR" }

total_price_presentment · object

The price of the order in minor units, such as cents. This is included if the price was shown to the customer in an alternate currency.

Show child attributes

Example:

{ "amount": 50000, "currency_code": "USD" }

total_discounts · object

The deduction from the original order price as a way to promote sales, special offers, or customer loyalty rewards.

Show child attributes

Example:

{ "amount": 50000, "currency_code": "USD" }

total_discounts_presentment · object

The deduction from the original order price as a way to promote sales, special offers, or customer loyalty rewards. This price is discounted from the original price according to the customer's local currency.

Show child attributes

Example:

{ "amount": 50000, "currency_code": "USD" }

total_taxes · object

The tax amount for the order.

Show child attributes

Example:

{ "amount": 50000, "currency_code": "USD" }

total_taxes_presentment · object

The tax amount for the order according to the customer's local currency.

Show child attributes

Example:

{ "amount": 50000, "currency_code": "USD" }

order_discounts · OrderDiscount · object[][] | null

Show child attributes

shipping_lines · object[] | null

Show child attributes

refunds · RefundItems · object[][]

List of refunds associated with the order.

Show child attributes

line_items · object[]

List of order line items associated with the order.

Show child attributes

fulfillments · object[] | null

Fulfillment information for the order.

Show child attributes

source · string | null

Maximum string length: 255

tags · string[] | null

created_at · string<date-time> | null

Example:

"2023-04-25T13:25:00-05:00"

updated_at · string<date-time> | null

Example:

"2023-04-25T13:25:00-05:00"

Response

200

application/json

OK

order · OrderResponse · object

Show child attributes