V4MOS.AI API
GuidesAPI Referenceapp.v4mos.ai
Shopify

Orders

GET
/v1/shopify/orders

Retrieve Shopify orders with payment, totals, and lifecycle timestamps

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

integrationId?string

Shopify integration identifier

integrationName?string

Shopify integration name

customerId?string

Filter by Shopify customer ID

storeId?string

Filter by store identifier

name?string

Filter by order name/#

id?string

Filter by order ID

page?integer

Page number (default 1)

Default1
limit?integer

Items per page (default 500, max 5000)

Rangevalue <= 5000
Default500
createdStart?string

Filter by creation date start (ISO 8601)

Formatdate-time
createdEnd?string

Filter by creation date end (ISO 8601)

Formatdate-time
lastModifiedStart?string

Filter by last update date start

Formatdate-time
lastModifiedEnd?string

Filter by last update date end

Formatdate-time
closedDateStart?string

Filter by closed date start

Formatdate-time
closedDateEnd?string

Filter by closed date end

Formatdate-time
processedDateStart?string

Filter by processed date start

Formatdate-time
processedDateEnd?string

Filter by processed date end

Formatdate-time

Response Body

Shopify orders response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/shopify/orders?organizationId=org_123"
{  "data": [    {      "id": "string",      "cancelled_at": "2019-08-24T14:15:22Z",      "cancel_reason": "string",      "closed": true,      "closed_at": "2019-08-24T14:15:22Z",      "confirmed": true,      "created_at": "2019-08-24T14:15:22Z",      "currency_code": "string",      "customer_id": "string",      "customer_email": "user@example.com",      "email": "user@example.com",      "fully_paid": true,      "name": "string",      "processed_at": "2019-08-24T14:15:22Z",      "source_name": "string",      "total_discounts_set_presentment_money_amount": 0.1,      "total_discounts_set_presentment_money_currency_code": "string",      "total_price_set_presentment_money_amount": 0.1,      "total_price_set_presentment_money_currency_code": "string",      "total_received_set_presentment_money_amount": 0.1,      "total_received_set_presentment_money_currency_code": "string",      "total_refunded_set_presentment_money_amount": 0.1,      "total_refunded_set_presentment_money_currency_code": "string",      "total_shipping_price_set_presentment_money_amount": 0.1,      "total_shipping_price_set_presentment_money_currency_code": "string",      "total_tax_set_presentment_money_amount": 0.1,      "total_tax_set_presentment_money_currency_code": "string",      "updated_at": "2019-08-24T14:15:22Z",      "integration_id": "string",      "organization_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}

Customers GET

Previous Page

Order Items GET

Next Page