Integrations - Shopify

cancelled_at contact_id created_at currency discount_amount id invoice_number lineitems notes refund_amount refund_reason refunded_at status tax_amount total_amount type updated_at url

Readable fields:

Writable fields:

cancelled_at contact_id currency discount_amount invoice_number lineitems notes refund_amount refund_reason refunded_at status tax_amount total_amount url

ACCOUNTING CONTACT

End-API object:

customer

Unified API Methods:

Webhooks:

Virtual Native

List options:

billing_address created_at currency emails first_name id is_customer is_supplier last_name name tax_exemption telephones updated_at

Readable fields:

Writable fields:

COMMERCE LOCATION

End-API object:

location

Unified API Methods:

Webhooks:

Native

List options:

Readable fields:

address created_at id is_active name updated_at

Writable fields:

item_variant_id limit location_id offset updated_gte

COMMERCE INVENTORY

End-API object:

inventory_level

Unified API Methods:

List Get Create Update Remove

Webhooks:

Virtual Native

List options:

Readable fields:

available id item_variant_id location_id updated_at

Writable fields:

available item_variant_id location_id

required fields

COMMERCE COLLECTION

End-API object:

custom_collection

Unified API Methods:

limit offset saleschannel_id type

Webhooks:

Virtual Native

List options:

Readable fields:

description id is_visible media name type updated_at

Writable fields:

collection_id limit offset updated_gte

COMMERCE ITEM

End-API object:

product

Unified API Methods:

List Get Create Update

Webhooks:

Virtual Native

List options:

Readable fields:

collections created_at description global_code id is_active is_taxable media metadata name prices slug tags total_stock type updated_at vendor_name

Writable fields:

collections description is_active is_taxable media metadata name public_description public_name slug tags type vendor_name

COMMERCE SALESCHANNEL

End-API object:

publication

Unified API Methods:

Get Create Update List

List options:

collections description id is_active slug

Readable fields:

Writable fields:

collections is_active

HRIS EMPLOYEE

End-API object:

user

Unified API Methods:

limit offset query updated_gte

Webhooks:

Virtual

List options:

Readable fields:

bio emails employee_roles first_name id language_locale last_name name telephones

Writable fields:

limit offset order sort_by_created_at sort_by_updated_at updated_gte

METADATA METADATA

End-API object:

metafielddefinition

Unified API Methods:

List Get Create Update

List options:

limit offset type

Readable fields:

format id name object_type objects options original_format slug

Slow fields:

options

Writable fields:

name object_type format slug

required fields

ACCOUNTING SALESORDER

End-API object:

order

Unified API Methods:

Get Create List

Webhooks:

Virtual

List options:

Slow fields:

lineitems fees

Writable fields:

account_id billing_address contact_id currency lineitems posted_at shipping_address status total_amount

ACCOUNTING CREDITMEMO

End-API object:

creditmemo

Unified API Methods:

Webhooks:

Virtual

List options:

created_at creditmemo_number currency id lineitems notes refund_amount refund_reason status total_amount updated_at

Readable fields:

Writable fields:

item_id collection_id limit offset updated_gte

COMMERCE ITEMVARIANT

End-API object:

productvariant

Unified API Methods:

Create Update Remove List Get

Webhooks:

Virtual

List options:

required filter

Readable fields:

created_at height id inventory_id is_active is_visible items length media metadata name options prices public_name requires_shipping size_unit sku total_stock weight weight_unit width

Writable fields:

items height inventory_id length media metadata name options prices requires_shipping size_unit sku total_stock weight weight_unit width

required fields

PAYMENT SUBSCRIPTION

End-API object:

subscriptioncontract

Unified API Methods:

Get List

Webhooks:

Virtual

List options:

contact_id created_at currency current_period_end_at day_of_month day_of_week id interval interval_unit invoice_id lineitems month start_at status total_amount updated_at

Readable fields:

Slow fields:

lineitems total_amount

Writable fields:

PAYMENT PAYOUT

End-API object:

shopifypaymentspayout

Unified API Methods:

List options:

created_at currency id lineitems net_amount status total_amount

Readable fields:

Writable fields:

PAYMENT PAYMENT

End-API object:

shopifypaymentsbalancetransaction

Unified API Methods:

created_at currency fee_amount id invoice_id net_amount paid_at reference salesorder_id total_amount

List options:

end_lt limit offset start_gte

Readable fields:

Writable fields:

PAYMENT REFUND

End-API object:

shopifypaymentsbalancetransaction

Unified API Methods:

List options:

created_at currency id reference refunded_at total_amount

Readable fields:

Writable fields:

SHIPPING SHIPMENT

End-API object:

fulfillment

Unified API Methods:

carrier_name created_at id lineitems order_id packages reference_number service_code shipped_at status tracking_id tracking_url updated_at warehouse_location_id

Webhooks:

Native

List options:

order_id limit

required filter

Readable fields:

Writable fields:

SHIPPING TRACKING

End-API object:

fulfillment

Unified API Methods:

carrier_id created_at id shipment_id status status_description tracking_number updated_at

Webhooks:

Native

List options:

order_id limit

required filter

Readable fields:

Writable fields: