Shopwaive API 2024-11
  • Shopwaive REST API
  • Quick Start
  • Reference
    • REST API documentation
      • Customer API
      • Action API
      • Order API
    • Shopwaive API rate limits
Powered by GitBook
On this page

Was this helpful?

  1. Reference
  2. REST API documentation

Order API

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

PreviousAction APINextShopwaive API rate limits

Last updated 6 months ago

Was this helpful?

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=support@shopwaive.com&created_at_min=2024-09-22T04:51:20.144Z&created_at_max=2024-09-22T19:14:22.688Z

POST order endpoint

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

Get orders

get
Authorizations
Responses
200
Successfully fetched orders
application/json
default
Unexpected error. Method not allowed
application/json
get
GET /api/orders HTTP/1.1
Host: app.shopwaive.com
X-Shopwaive-Access-Token: YOUR_API_KEY
Accept: */*
[]
  • GET orders endpoint
  • GETGet orders
  • POST order endpoint
  • POSTCreate customer order
  • Header
  • Request Body
  • Response Body

Create customer order

post
Authorizations
Body
customeridnumberRequiredExample: 6659662610648
free_shippingbooleanOptionalExample: true
tagsstringOptionalExample: New customer, Store Credit, Marketing promo, Exclusive
descriptionstringRequiredExample: Store Credit
amountnumberRequiredExample: 450
Responses
200
Successfully created customer checkout url
application/json
default
Unexpected error. Method not allowed
application/json
post
POST /api/order HTTP/1.1
Host: app.shopwaive.com
X-Shopwaive-Access-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "customerid": "6659662610648",
  "free_shipping": true,
  "tags": "New customer, Store Credit, Marketing promo, Exclusive",
  "order_notes": [],
  "description": "Store Credit",
  "amount": "450",
  "cart": []
}
{
  "status": "success",
  "checkout_url": "https://example.myshopify.com/60557656280/invoices/b187f60bbb34efd05d15233cdfba5b84"
}