Order API

Create Shopify orders with store credit automatically applied with the Shopwaive Order API

Good to know: This API method provides developers the ability to expedite cart creation with a direct link to checkout with stacked discounts (i.e. line items discounted with promo and store credit applied). Gift cards can also be optionally applied at checkout.

GET orders endpoint

Search and filter customer orders by including any combination of query key value pairs id,email,created_at_min, or created_at_max appended to the /api/orders endpoint. A maximum of 250 records per request are returned in the response body. Dates should use ISOString format when appended as a query string, for example, new Date().toISOString().

// Example date and email constrained request

https://app.shopwaive.com/api/orders?email=[e-mail]&created_at_min=2024-09-22T04:51:20.144Z&created_at_max=2024-09-22T19:14:22.688Z

Get orders

GEThttps://app.shopwaive.com/api/orders

Response

200default

Successfully fetched orders

Headers

Body

application/json

orderidnumber

Example: 5821204005044

statusstring

Example: "order"

datestring

Example: "2024-04-07T13:49:54.078Z"

order_namenumber

Example: 848548

emailstring

Example: "[e-mail]"

redeemednumber

Example: 258.4

Request

JavaScriptCurlPython

const response = await fetch('https://app.shopwaive.com/api/orders', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

[
  {
    "orderid": 5821204005044,
    "status": "order",
    "date": "2024-04-07T13:49:54.078Z",
    "order_name": 848548,
    "email": "[e-mail]",
    "redeemed": 258.4
  }
]

POST order endpoint

Create customer order

POSThttps://app.shopwaive.com/api/order

Body

application/json

Create order

customerid*number

Example: "6659662610648"

free_shippingboolean

Example: true

tagsstring

Example: "New customer, Store Credit, Marketing promo, Exclusive"

order_notesarray of object

description*string

Example: "Store Credit"

amount*number

Example: "450"

cart*array of object

Response

200default

Successfully created customer checkout url

Headers

Body

application/json

statusstring

Example: "success"

checkout_urlstring

Example: "https://example.myshopify.com/60557656280/invoices/b187f60bbb34efd05d15233cdfba5b84"

Request

JavaScriptCurlPython

const response = await fetch('https://app.shopwaive.com/api/order', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customerid": "6659662610648",
      "description": "Store Credit",
      "amount": "450",
      "cart": [
        {}
      ]
    }),
});
const data = await response.json();

Response

200default

{
  "status": "success",
  "checkout_url": "https://example.myshopify.com/60557656280/invoices/b187f60bbb34efd05d15233cdfba5b84"
}

Header

key	value
X-Shopwaive-Access-Token	Store's platform API key for store (required)
X-Shopwaive-Platform	Store's platform (required)
Content-Type	Content type

Request Body

key	value
customerid	Customer id associated with store's platform
free_shipping	Boolean
tags	Tags to apply to order
order_notes	Additional details or notes to apply to order
description	Description of credit applied (i.e. Store Credit)
amount	Amount of credit to apply to order
cart	Customer cart associated with order

Response Body

key	value
status	Status message
checkout_url	Checkout url to be used by customer for payment