Companies
Liliia Ostrovska
List of companies in the shop. Represents information about companies which is also a customers of the shop.
Field | Description |
|---|
Field | Description |
|---|---|
Contacts count | The number of contacts that belong to the company. |
Contacts count precision | Precision of contacts count, how exact is the value. |
Created at | The date and time (ISO 8601 format) at which the company was created in Shopify. |
Customer since | The date and time (ISO 8601 format) at which the company became the customer. |
Default cursor | A default cursor that returns the single next record, sorted ascending by ID. |
External ID | A unique externally-supplied ID for the company. |
Has timeline comment | Whether the merchant added a timeline comment to the company. |
ID | Globally unique identifier. |
Lifetime duration | The lifetime duration of the company, since it became a customer of the shop. Examples: 2 days, 3 months, 1 year. |
Locations count | The number of locations that belong to the company. |
Locations count precision | Precision of locations count, how exact is the value. |
Name | The name of the company. |
Note | A note about the company. |
Orders count | The total number of orders placed for this company, across all its locations. |
Orders count precision | Precision of orders count, how exact is the value. |
Total spent | The total amount spent by this company, across all its locations. |
Updated at | The date and time (ISO 8601 format) at which the company was last modified. |
The list of roles for the company contacts.
Field | Description |
|---|
Field | Description |
|---|---|
ID | Globally unique identifier. |
Name | The name of a role. For example, 'admin' or 'buyer'. |
Note | A note for the role. |
The list of contacts in the company.
Field | Description |
|---|
Field | Description |
|---|---|
Created at | The date and time (ISO 8601 format) at which the company contact was created at Shopify. |
ID | Globally unique identifier. |
Is main contact | Whether the contact is the main contact of the company. |
Lifetime duration | The lifetime duration of the company contact, since its creation date on Shopify. Examples: 1 year, 2 months, 3 days. |
Locale | The company contact's locale (language). |
Title | The company contact's job title. |
Updated at | The date and time (ISO 8601 format) at which the company contact was last updated. |
The customer associated to this contact.
Field | Description |
|---|
Field | Description |
|---|---|
Accepts marketing | Whether the customer has agreed to receive marketing materials. |
Accepts marketing updated at | The date and time when the customer consented or objected to receiving marketing material by email. |
Amount spent | The total amount that the customer has spent on orders in their lifetime. |
Average order amount | The average amount that the customer spent per order. |
Can delete | Whether the merchant can delete the customer from their store |
Created at | The date and time when the customer was added to the store. |
Display name | The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. |
The customer's email address. | |
First name | The customer's first name. |
Has timeline comment | Whether the merchant has added timeline comments about the customer on the customer's page. |
ID | Globally unique identifier. |
Image alt text | A word or phrase to share the nature or contents of an image associated with the customer. |
Last name | The customer's last name. |
Lifetime duration | The amount of time since the customer was first added to the store. |
Locale | The customer's locale. |
Multipass identifier | A unique identifier for the customer that's used with Multipass login. |
Note | A note about the customer. |
Number of orders | The number of orders that the customer has made at the store in their lifetime. |
Original image URL | The location of the original image associated with the customer as a URL. |
Phone | The customer's phone number. |
State | The state of the customer's account with the shop. |
Tags | A comma separated list of tags that have been added to the customer. |
Tax exempt | Whether the customer is exempt from being charged taxes on their orders. |
Transformed image URL | The location of the transformed image associated with the customer as a URL. |
Updated at | The date and time when the customer was last updated. |
Valid email address | Whether the email address is formatted correctly. This does not guarantee that the email address actually exists. |
Verified email | Whether the customer has verified their email address. |
The role proposed by default for a contact at the company.
Field | Description |
|---|
Field | Description |
|---|---|
ID | Globally unique identifier. |
Name | The name of a role. For example, 'admin' or 'buyer'. |
Note | A note for the role. |
The list of the company's draft orders.
Field | Description |
|---|
Field | Description |
|---|---|
Completed at | Date and time when the draft order converted to a new order, and the draft order's status changed to Completed. |
Created at | Date and time when the draft order was created in Shopify. |
Currency code | Three letter code for the currency of the store at the time that the invoice is sent. |
Email address of the customer, which is used to send notifications to. | |
Has timeline comment | Whether the merchant has added timeline comments to the draft order. |
ID | Globally unique identifier. |
Invoice URL | Link to the checkout, which is sent to your customer in the invoice email. |
Invoice sent at | Date and time when the invoice was last emailed to the customer. |
Name | Unique identifier for the draft order, which is unique within the store. For example, #D1223. |
Note | Text from an optional note attached to the draft order. |
Ready | Whether or not the Draft Order is ready and can be completed. Draft Orders may have asynchronous operations that can take time to finish. |
Status | Status of the draft order. |
Subtotal price | Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes). |
Tags | A comma separated list of tags associated with the draft order. |
Tax exempt | Whether the draft order is tax exempt. |
Taxes included | Whether the line item prices include taxes. |
Total price | Total amount of the draft order (includes taxes, shipping charges, and discounts). |
Total shipping price | Total shipping charge for the draft order. |
Total tax | Total amount of taxes for the draft order. |
Total weight | Total weight (grams) of the draft order. |
Updated at | Date and time when the draft order was last changed. The format is YYYY-MM-DD HH:mm:ss (for example, 2016-02-05 17:04:01). |
The list of locations in the company.
Field | Description |
|---|
Field | Description |
|---|---|
Catalogs count | The number of catalogs associated with the company location. Limited to a maximum of 10000. |
Catalogs count precision | Precision of catalogs count, how exact is the value. |
Created at | The date and time (ISO 8601 format) at which the company location was created in Shopify. |
Currency | The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. |
Default cursor | A default cursor that returns the single next record, sorted ascending by ID. |
External ID | A unique externally-supplied ID for the company location. |
Has timeline comment | Whether the merchant added a timeline comment to the company location |
ID | Globally unique identifier. |
Locale | The preferred locale of the company location. |
Name | The name of the company location. |
Note | A note about the company location. |
Orders count | The total number of orders placed for the location. |
Orders count precision | Precision of orders count, how exact is the value. |
Phone | The phone number of the company location. |
Tax registration ID | The tax registration ID for the company location. |
Total spent | The total amount spent by the location. |
Updated at | The date and time (ISO 8601 format) at which the company location was last modified. |
The main contact for the company.
Field | Description |
|---|
Field | Description |
|---|---|
Created at | The date and time (ISO 8601 format) at which the company contact was created at Shopify. |
ID | Globally unique identifier. |
Is main contact | Whether the contact is the main contact of the company. |
Lifetime duration | The lifetime duration of the company contact, since its creation date on Shopify. Examples: 1 year, 2 months, 3 days. |
Locale | The company contact's locale (language). |
Title | The company contact's job title. |
Updated at | The date and time (ISO 8601 format) at which the company contact was last updated. |
List of metafields that belong to the resource.
Field | Description |
|---|
Field | Description |
|---|---|
Created at | The date and time when the metafield was created. |
Description | The description of a metafield. |
ID | Globally unique identifier. |
Key | The key name for a metafield. |
Namespace | The namespace for a metafield. |
Owner type | Owner type of a metafield visible to the Storefront API. |
Type | The type of data that the metafield stores in the value field. |
Updated at | The date and time when the metafield was updated. |
Value | The value of a metafield. |
The list of the company's orders.
Field | Description |
|---|
Field | Description |
|---|---|
Billing address matches the shipping address | Whether the billing address matches the shipping address. |
Can marked as paid | Whether the order can be manually marked as paid. |
Can notify customer | Whether notifications can be sent to the customer or not. |
Cancel reason | Reason the order was canceled. Returns null if the order wasn't canceled. |
Cancelled at | Date and time when the order was canceled. Returns null if the order wasn't canceled. |
Capturable | Whether payment for the order can be captured. Returns true when the customer's credit card has been authorized for payment and the authorization period has not expired. |
Client ip | The ip address of the client that is associated with this order. |
Closed | Whether the order is closed. |
Closed at | Date and time when the order closed. If the order is not closed, then this field is null. |
Confirmed | Whether inventory has been reserved for the order. |
Created at | Date and time when the order was created in Shopify. |
Currency code | The currency of the store at the time of the order. If payment hasn't occurred, then this field is null. |
Current subtotal line items quantity | The sum of the quantities for the line items that contribute to the order's subtotal. |
Current total weight | The total weight (grams) of the order minus the weights for line items that have been returned. |
Customer accepts marketing | Whether the customer agreed to receive marketing materials. |
Customer locale | A two-letter or three-letter language code, optionally followed by a region modifier. |
Discount code | The discount code used for the order. |
Discount codes | The discount codes used for the order. |
Display financial status | Financial status of the order that can be shown to the merchant. This field does not capture all the possible details of an order's financial state and should only be used for display summary purposes. |
Display fulfillment status | Fulfillment status for the order that can be shown to the merchant. This field does not capture all the possible details of an order's fulfillment state. It should only be used for display summary purposes. |
Edited | Whether the order has had any edits applied or not. |
Email address provided by the customer. | |
Fulfillable | Whether there are items that can be fulfilled. After an order is completely fulfilled (or completely refunded without any fulfillments) then this field returns false. |
Fully paid | Whether the order has been paid in full. |
Has timeline comment | Whether the merchant added timeline comments to the order. |
ID | Globally unique identifier. |
Merchant editable | Whether the order can be edited or not. |
Name | Unique identifier for the order that appears on the order. For example, #1000 or _Store1001. This value is not unique across multiple stores. |
Note | Contents of the note associated with the order. |
Payment gateways | List of all payment gateways used for the order. For example, authorize_net and Cash on Delivery (COD). |
Phone | Phone number provided by the customer. |
Presentment cart discount | Amount of the order-level discount (does not contain any line item discounts) in presentment currency. |
Presentment currency | The payment currency of the customer for this order. |
Presentment current cart discount | The amount of the order-level discount minus the amounts for line items that have been returned in presentment currency. This doesn't include line item discounts. |
Presentment current subtotal price | The subtotal of line items and their discounts minus the line items that have been returned in presentment currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order. |
Presentment current total discounts | The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in presentment currency. |
Presentment current total duties | Total amount of duties for the order in presentment currency. If duties are not applicable, then this value is null. |
Presentment current total price | The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in presentment currency. |
Presentment current total tax | The total of all taxes applied to the order minus the taxes for line items that have been returned in presentment currency. |
Presentment net payment | Net payment for the order, based on the total amount received - total amount refunded in presentment currency. |
Presentment original total duties | Total amount of duties prior to any applied edits for the order in presentment currency. If duties are not applicable, then this value is null. |
Presentment original total price | Total price of the order prior to any applied edits in presentment currency. |
Presentment refund discrepancy | The difference between suggested and actual refund amounts in presentment currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor. |
Presentment subtotal price | Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in presentment currency. |
Presentment total capturable | Amount authorized for the order, that is uncaptured or undercaptured in presentment currency. |
Presentment total discounts | Total amount discounted from the order (includes order-level and line item discounts) in presentment currency. |
Presentment total outstanding | Total amount of money not yet authorized for the order in presentment currency. |
Presentment total price | Total amount of the order (includes taxes and discounts) in presentment currency. |
Presentment total received | Total amount received by the customer for the order in presentment currency. |
Presentment total refunded | Total amount refunded for the order in presentment currency. |
Presentment total refunded shipping | Total amount refunded for shipping in presentment currency. |
Presentment total shipping price | Total amount charged for shipping the order in presentment currency. |
Presentment total tax | Total of all taxes applied to the order in presentment currency. |
Processed at | Date and time when the order was processed. When orders are imported from an app, this date and time may not match the date and time when the order was created. |
Refundable | Whether the order can be refunded. |
Requires shipping | Whether any line item in the order requires physical shipping. |
Restockable | Whether the order can be restocked. |
Risk level | Fraud risk level of the order. |
Shop cart discount | Amount of the order-level discount (does not contain any line item discounts) in shop currency. |
Shop current cart discount | The amount of the order-level discount minus the amounts for line items that have been returned in shop currency. This doesn't include line item discounts. |
Shop current subtotal price | The subtotal of line items and their discounts minus the line items that have been returned in shop currency. This includes order-level discounts, unless the argument with_cart_discount is set to false. This doesn't include shipping costs and shipping discounts. Taxes are not included unless the order is a taxes-included order. |
Shop current total discounts | The total amount discounted from the order (including order-level and line item discounts) minus the amounts for items that have been returned in shop currency. |
Shop current total duties | Total amount of duties for the order in shop currency. If duties are not applicable, then this value is null. |
Shop current total price | The total amount of the order (including taxes and discounts) minus the amounts for line items that have been returned in shop currency. |
Shop current total tax | The total of all taxes applied to the order minus the taxes for line items that have been returned in shop currency. |
Shop net payment | Net payment for the order, based on the total amount received - total amount refunded in shop currency. |
Shop original refund discrepancy | The difference between suggested and actual refund amounts in shop currency. A positive value indicates a difference in the merchants favor and a negative value indicates a difference in the customers favor. |
Shop original total duties | Total amount of duties prior to any applied edits for the order in shop currency. If duties are not applicable, then this value is null. |
Shop original total price | Total price of the order prior to any applied edits in shop currency. |
Shop subtotal price | Subtotal of the line items and their discounts (does not contain shipping costs and shipping discounts) in shop currency. |
Shop total capturable | Amount authorized for the order, that is uncaptured or undercaptured in shop currency. |
Shop total discounts | Total amount discounted from the order (includes order-level and line item discounts) in shop currency. |
Shop total outstanding |