--- title: "Integrations - Shopify" url: "https://docs.unified.to/integrations/shopify" description: "Unified.to documentation" --- ## Integration: Shopify ![Shopify](https://api.unified.to/docs/images/shopify.png) [Back to integrations](/integrations) #### Overview Company website: Integration launch date: January 24, 2024 API Categories: [E-Commerce](/commerce/overview)[Accounting](/accounting/overview)[HR & Directory](/hris/overview)[Authentication](/auth/overview)[Payments](/payment/overview)[Metadata](/metadata/overview)[Shipping](/shipping/overview)[Passthrough](/passthrough/overview) API Authorization: OAuth2 flow Admin API access token / Store ID #### ACCOUNTING INVOICE End-API object: order Unified API Methods: [List](/accounting/invoice/List%5Fall%5Finvoices)[Get](/accounting/invoice/Retrieve%5Fan%5Finvoice)[Create](/accounting/invoice/Create%5Fan%5Finvoice)[Update](/accounting/invoice/Update%5Fan%5Finvoice) Webhooks: Virtual List options: limitoffsetupdated\_gte Readable fields: [cancelled\_at](/accounting/invoice/model)[contact\_id](/accounting/invoice/model)[created\_at](/accounting/invoice/model)[currency](/accounting/invoice/model)[discount\_amount](/accounting/invoice/model)[id](/accounting/invoice/model)[invoice\_number](/accounting/invoice/model)[lineitems](/accounting/invoice/model)[notes](/accounting/invoice/model)[refund\_amount](/accounting/invoice/model)[refund\_reason](/accounting/invoice/model)[refunded\_at](/accounting/invoice/model)[status](/accounting/invoice/model)[tax\_amount](/accounting/invoice/model)[total\_amount](/accounting/invoice/model)[type](/accounting/invoice/model)[updated\_at](/accounting/invoice/model)[url](/accounting/invoice/model) Writable fields: [cancelled\_at](/accounting/invoice/model)[contact\_id](/accounting/invoice/model)[currency](/accounting/invoice/model)[discount\_amount](/accounting/invoice/model)[invoice\_number](/accounting/invoice/model)[lineitems](/accounting/invoice/model)[notes](/accounting/invoice/model)[refund\_amount](/accounting/invoice/model)[refund\_reason](/accounting/invoice/model)[refunded\_at](/accounting/invoice/model)[status](/accounting/invoice/model)[tax\_amount](/accounting/invoice/model)[total\_amount](/accounting/invoice/model)[url](/accounting/invoice/model) #### ACCOUNTING CONTACT End-API object: customer Unified API Methods: [List](/accounting/contact/List%5Fall%5Fcontacts)[Get](/accounting/contact/Retrieve%5Fa%5Fcontact) Webhooks: Virtual Native List options: limitoffsetupdated\_gte Readable fields: [billing\_address](/accounting/contact/model)[created\_at](/accounting/contact/model)[currency](/accounting/contact/model)[emails](/accounting/contact/model)[first\_name](/accounting/contact/model)[id](/accounting/contact/model)[is\_customer](/accounting/contact/model)[is\_supplier](/accounting/contact/model)[last\_name](/accounting/contact/model)[name](/accounting/contact/model)[tax\_exemption](/accounting/contact/model)[telephones](/accounting/contact/model)[updated\_at](/accounting/contact/model) Writable fields: [\-none-](/accounting/contact/model) #### COMMERCE LOCATION End-API object: location Unified API Methods: [List](/commerce/location/List%5Fall%5Flocations)[Get](/commerce/location/Retrieve%5Fa%5Flocation) Webhooks: Native List options: limitoffset Readable fields: [address](/commerce/location/model)[created\_at](/commerce/location/model)[id](/commerce/location/model)[is\_active](/commerce/location/model)[name](/commerce/location/model)[updated\_at](/commerce/location/model) Writable fields: [\-none-](/commerce/location/model) #### COMMERCE INVENTORY End-API object: inventory\_level Unified API Methods: [List](/commerce/inventory/List%5Fall%5Finventories)[Get](/commerce/inventory/Retrieve%5Fan%5Finventory)[Create](/commerce/inventory/Create%5Fan%5Finventory)[Update](/commerce/inventory/Update%5Fan%5Finventory)[Remove](/commerce/inventory/Remove%5Fan%5Finventory) Webhooks: Virtual Native List options: item\_variant\_idlimitlocation\_idoffsetupdated\_gte Readable fields: [available](/commerce/inventory/model)[id](/commerce/inventory/model)[item\_variant\_id](/commerce/inventory/model)[location\_id](/commerce/inventory/model)[updated\_at](/commerce/inventory/model) Writable fields: [available](/commerce/inventory/model)[item\_variant\_id](/commerce/inventory/model)[location\_id](/commerce/inventory/model) required fields #### COMMERCE COLLECTION End-API object: custom\_collection Unified API Methods: [List](/commerce/collection/List%5Fall%5Fcollections)[Get](/commerce/collection/Retrieve%5Fa%5Fcollection) Webhooks: Virtual Native List options: limitoffsetsaleschannel\_idtype Readable fields: [description](/commerce/collection/model)[id](/commerce/collection/model)[is\_visible](/commerce/collection/model)[media](/commerce/collection/model)[name](/commerce/collection/model)[type](/commerce/collection/model)[updated\_at](/commerce/collection/model) Writable fields: [\-none-](/commerce/collection/model) #### COMMERCE ITEM End-API object: product Unified API Methods: [List](/commerce/item/List%5Fall%5Fitems)[Get](/commerce/item/Retrieve%5Fan%5Fitem)[Create](/commerce/item/Create%5Fan%5Fitem)[Update](/commerce/item/Update%5Fan%5Fitem) Webhooks: Virtual Native List options: collection\_idlimitoffsetupdated\_gte Readable fields: [collections](/commerce/item/model)[created\_at](/commerce/item/model)[description](/commerce/item/model)[global\_code](/commerce/item/model)[id](/commerce/item/model)[is\_active](/commerce/item/model)[is\_taxable](/commerce/item/model)[media](/commerce/item/model)[metadata](/commerce/item/model)[name](/commerce/item/model)[prices](/commerce/item/model)[slug](/commerce/item/model)[tags](/commerce/item/model)[total\_stock](/commerce/item/model)[type](/commerce/item/model)[updated\_at](/commerce/item/model)[vendor\_name](/commerce/item/model) Writable fields: [collections](/commerce/item/model)[description](/commerce/item/model)[is\_active](/commerce/item/model)[is\_taxable](/commerce/item/model)[media](/commerce/item/model)[metadata](/commerce/item/model)[name](/commerce/item/model)[public\_description](/commerce/item/model)[public\_name](/commerce/item/model)[slug](/commerce/item/model)[tags](/commerce/item/model)[type](/commerce/item/model)[vendor\_name](/commerce/item/model) #### COMMERCE SALESCHANNEL End-API object: publication Unified API Methods: [Get](/commerce/saleschannel/Retrieve%5Fa%5Fsaleschannel)[Create](/commerce/saleschannel/Create%5Fa%5Fsaleschannel)[Update](/commerce/saleschannel/Update%5Fa%5Fsaleschannel)[List](/commerce/saleschannel/List%5Fall%5Fsaleschannels) List options: limitoffset Readable fields: [collections](/commerce/saleschannel/model)[description](/commerce/saleschannel/model)[id](/commerce/saleschannel/model)[is\_active](/commerce/saleschannel/model)[slug](/commerce/saleschannel/model) Writable fields: [collections](/commerce/saleschannel/model)[is\_active](/commerce/saleschannel/model) #### HRIS EMPLOYEE End-API object: user Unified API Methods: [List](/hris/employee/List%5Fall%5Femployees)[Get](/hris/employee/Retrieve%5Fan%5Femployee) Webhooks: Virtual List options: limitoffsetqueryupdated\_gte Readable fields: [bio](/hris/employee/model)[emails](/hris/employee/model)[employee\_roles](/hris/employee/model)[first\_name](/hris/employee/model)[id](/hris/employee/model)[language\_locale](/hris/employee/model)[last\_name](/hris/employee/model)[name](/hris/employee/model)[telephones](/hris/employee/model) Writable fields: [\-none-](/hris/employee/model) #### METADATA METADATA End-API object: metafielddefinition Unified API Methods: [List](/metadata/metadata/List%5Fall%5Fmetadatas)[Get](/metadata/metadata/Retrieve%5Fa%5Fmetadata)[Create](/metadata/metadata/Create%5Fa%5Fmetadata)[Update](/metadata/metadata/Update%5Fa%5Fmetadata) List options: limitoffsettype Readable fields: [format](/metadata/metadata/model)[id](/metadata/metadata/model)[name](/metadata/metadata/model)[object\_type](/metadata/metadata/model)[objects](/metadata/metadata/model)[options](/metadata/metadata/model)[original\_format](/metadata/metadata/model)[slug](/metadata/metadata/model) Slow fields: [options](/metadata/metadata/model) Writable fields: [name](/metadata/metadata/model)[object\_type](/metadata/metadata/model)[format](/metadata/metadata/model)[slug](/metadata/metadata/model) required fields #### ACCOUNTING SALESORDER End-API object: order Unified API Methods: [Get](/accounting/salesorder/Retrieve%5Fa%5Fsalesorder)[Create](/accounting/salesorder/Create%5Fa%5Fsalesorder)[List](/accounting/salesorder/List%5Fall%5Fsalesorders) Webhooks: Virtual List options: limitoffsetordersort\_by\_created\_atsort\_by\_updated\_atupdated\_gte Readable fields: [billing\_address](/accounting/salesorder/model)[closed\_at](/accounting/salesorder/model)[contact\_id](/accounting/salesorder/model)[created\_at](/accounting/salesorder/model)[currency](/accounting/salesorder/model)[discount\_amount](/accounting/salesorder/model)[fees](/accounting/salesorder/model)[id](/accounting/salesorder/model)[lineitems](/accounting/salesorder/model)[location\_id](/accounting/salesorder/model)[order\_number](/accounting/salesorder/model)[posted\_at](/accounting/salesorder/model)[sales\_channel](/accounting/salesorder/model)[shipping\_address](/accounting/salesorder/model)[status](/accounting/salesorder/model)[subtotal\_amount](/accounting/salesorder/model)[tax\_amount](/accounting/salesorder/model)[tip\_amount](/accounting/salesorder/model)[total\_amount](/accounting/salesorder/model)[updated\_at](/accounting/salesorder/model) Slow fields: [lineitems](/accounting/salesorder/model)[fees](/accounting/salesorder/model) Writable fields: [account\_id](/accounting/salesorder/model)[billing\_address](/accounting/salesorder/model)[contact\_id](/accounting/salesorder/model)[currency](/accounting/salesorder/model)[lineitems](/accounting/salesorder/model)[posted\_at](/accounting/salesorder/model)[shipping\_address](/accounting/salesorder/model)[status](/accounting/salesorder/model)[total\_amount](/accounting/salesorder/model) #### ACCOUNTING CREDITMEMO End-API object: creditmemo Unified API Methods: [List](/accounting/creditmemo/List%5Fall%5Fcreditmemoes)[Get](/accounting/creditmemo/Retrieve%5Fa%5Fcreditmemo) Webhooks: Virtual List options: limitoffsetupdated\_gte Readable fields: [created\_at](/accounting/creditmemo/model)[creditmemo\_number](/accounting/creditmemo/model)[currency](/accounting/creditmemo/model)[id](/accounting/creditmemo/model)[lineitems](/accounting/creditmemo/model)[notes](/accounting/creditmemo/model)[refund\_amount](/accounting/creditmemo/model)[refund\_reason](/accounting/creditmemo/model)[status](/accounting/creditmemo/model)[total\_amount](/accounting/creditmemo/model)[updated\_at](/accounting/creditmemo/model) Writable fields: [\-none-](/accounting/creditmemo/model) #### COMMERCE ITEMVARIANT End-API object: productvariant Unified API Methods: [Create](/commerce/itemvariant/Create%5Fan%5Fitemvariant)[Update](/commerce/itemvariant/Update%5Fan%5Fitemvariant)[Remove](/commerce/itemvariant/Remove%5Fan%5Fitemvariant)[List](/commerce/itemvariant/List%5Fall%5Fitemvariants)[Get](/commerce/itemvariant/Retrieve%5Fan%5Fitemvariant) Webhooks: Virtual List options: item\_idcollection\_idlimitoffsetupdated\_gte required filter Readable fields: [created\_at](/commerce/itemvariant/model)[height](/commerce/itemvariant/model)[id](/commerce/itemvariant/model)[inventory\_id](/commerce/itemvariant/model)[is\_active](/commerce/itemvariant/model)[is\_visible](/commerce/itemvariant/model)[items](/commerce/itemvariant/model)[length](/commerce/itemvariant/model)[media](/commerce/itemvariant/model)[metadata](/commerce/itemvariant/model)[name](/commerce/itemvariant/model)[options](/commerce/itemvariant/model)[prices](/commerce/itemvariant/model)[public\_name](/commerce/itemvariant/model)[requires\_shipping](/commerce/itemvariant/model)[size\_unit](/commerce/itemvariant/model)[sku](/commerce/itemvariant/model)[total\_stock](/commerce/itemvariant/model)[weight](/commerce/itemvariant/model)[weight\_unit](/commerce/itemvariant/model)[width](/commerce/itemvariant/model) Writable fields: [items](/commerce/itemvariant/model)[height](/commerce/itemvariant/model)[inventory\_id](/commerce/itemvariant/model)[length](/commerce/itemvariant/model)[media](/commerce/itemvariant/model)[metadata](/commerce/itemvariant/model)[name](/commerce/itemvariant/model)[options](/commerce/itemvariant/model)[prices](/commerce/itemvariant/model)[requires\_shipping](/commerce/itemvariant/model)[size\_unit](/commerce/itemvariant/model)[sku](/commerce/itemvariant/model)[total\_stock](/commerce/itemvariant/model)[weight](/commerce/itemvariant/model)[weight\_unit](/commerce/itemvariant/model)[width](/commerce/itemvariant/model) required fields #### PAYMENT SUBSCRIPTION End-API object: subscriptioncontract Unified API Methods: [Get](/payment/subscription/Retrieve%5Fa%5Fsubscription)[List](/payment/subscription/List%5Fall%5Fsubscriptions) Webhooks: Virtual List options: limitoffsetupdated\_gte Readable fields: [contact\_id](/payment/subscription/model)[created\_at](/payment/subscription/model)[currency](/payment/subscription/model)[current\_period\_end\_at](/payment/subscription/model)[day\_of\_month](/payment/subscription/model)[day\_of\_week](/payment/subscription/model)[id](/payment/subscription/model)[interval](/payment/subscription/model)[interval\_unit](/payment/subscription/model)[invoice\_id](/payment/subscription/model)[lineitems](/payment/subscription/model)[month](/payment/subscription/model)[start\_at](/payment/subscription/model)[status](/payment/subscription/model)[total\_amount](/payment/subscription/model)[updated\_at](/payment/subscription/model) Slow fields: [lineitems](/payment/subscription/model)[total\_amount](/payment/subscription/model) Writable fields: [\-none-](/payment/subscription/model) #### PAYMENT PAYOUT End-API object: shopifypaymentspayout Unified API Methods: [List](/payment/payout/List%5Fall%5Fpayouts)[Get](/payment/payout/Retrieve%5Fa%5Fpayout) List options: limitoffset Readable fields: [created\_at](/payment/payout/model)[currency](/payment/payout/model)[id](/payment/payout/model)[lineitems](/payment/payout/model)[net\_amount](/payment/payout/model)[status](/payment/payout/model)[total\_amount](/payment/payout/model) Writable fields: [\-none-](/payment/payout/model) #### PAYMENT PAYMENT End-API object: shopifypaymentsbalancetransaction Unified API Methods: [List](/payment/payment/List%5Fall%5Fpayments)[Get](/payment/payment/Retrieve%5Fa%5Fpayment) List options: end\_ltlimitoffsetstart\_gte Readable fields: [created\_at](/payment/payment/model)[currency](/payment/payment/model)[fee\_amount](/payment/payment/model)[id](/payment/payment/model)[invoice\_id](/payment/payment/model)[net\_amount](/payment/payment/model)[paid\_at](/payment/payment/model)[reference](/payment/payment/model)[salesorder\_id](/payment/payment/model)[total\_amount](/payment/payment/model) Writable fields: [\-none-](/payment/payment/model) #### PAYMENT REFUND End-API object: shopifypaymentsbalancetransaction Unified API Methods: [List](/payment/refund/List%5Fall%5Frefunds)[Get](/payment/refund/Retrieve%5Fa%5Frefund) List options: limitoffset Readable fields: [created\_at](/payment/refund/model)[currency](/payment/refund/model)[id](/payment/refund/model)[reference](/payment/refund/model)[refunded\_at](/payment/refund/model)[total\_amount](/payment/refund/model) Writable fields: [\-none-](/payment/refund/model) #### SHIPPING SHIPMENT End-API object: fulfillment Unified API Methods: [List](/shipping/shipment/List%5Fall%5Fshipments)[Get](/shipping/shipment/Retrieve%5Fa%5Fshipment) Webhooks: Native List options: order\_idlimit required filter Readable fields: [carrier\_name](/shipping/shipment/model)[created\_at](/shipping/shipment/model)[id](/shipping/shipment/model)[lineitems](/shipping/shipment/model)[order\_id](/shipping/shipment/model)[packages](/shipping/shipment/model)[reference\_number](/shipping/shipment/model)[service\_code](/shipping/shipment/model)[shipped\_at](/shipping/shipment/model)[status](/shipping/shipment/model)[tracking\_id](/shipping/shipment/model)[tracking\_url](/shipping/shipment/model)[updated\_at](/shipping/shipment/model)[warehouse\_location\_id](/shipping/shipment/model) Writable fields: [\-none-](/shipping/shipment/model) #### SHIPPING TRACKING End-API object: fulfillment Unified API Methods: [List](/shipping/tracking/List%5Fall%5Ftrackings)[Get](/shipping/tracking/Retrieve%5Fa%5Ftracking) Webhooks: Native List options: order\_idlimit required filter Readable fields: [carrier\_id](/shipping/tracking/model)[created\_at](/shipping/tracking/model)[id](/shipping/tracking/model)[shipment\_id](/shipping/tracking/model)[status](/shipping/tracking/model)[status\_description](/shipping/tracking/model)[tracking\_number](/shipping/tracking/model)[updated\_at](/shipping/tracking/model) Writable fields: [\-none-](/shipping/tracking/model) #### PASSTHROUGH Unified API Methods: [POST](/passthrough/overview)[GET](/passthrough/overview)[PUT](/passthrough/overview)[DELETE](/passthrough/overview) List options: \-none- Readable fields: [\-none-](/passthrough/undefined/model) Writable fields: [\-none-](/passthrough/undefined/model)