Module shopify.admin
ballerinax/shopify.admin Ballerina library
3.0.0
Overview
Shopify is a leading e-commerce platform that enables users to create, manage, and grow their online stores, offering secure transactions, inventory management, and seamless integrations.
The Ballerina Shopify admin connector allows developers to interact with the Shopify Admin REST APIs. It provides an easy-to-use interface for managing products, orders, customers, and other essential e-commerce functionalities. The module supports Shopify API versions up to the 2026-01 release.
Setup guide
Follow these steps to generate an access token for Shopify Admin APIs using the Ballerina Shopify connector.
1. Sign up for a Shopify developer account
-
Create a Shopify account via the Shopify signup portal.
-
Join the Shopify partner program to access development tools.
2. Create a new organization
In the Shopify partner dashboard, you can either connect to an existing organization or create a new one. If you don’t already have an organization, follow these steps to create one.
-
Follow the on-screen instructions and provide the necessary details.
-
Provide business contact details and finalize the setup.
3. Create a development store
-
In the Shopify partner dashboard, select Stores section from the left navigation panel.
-
Then you will be redirected to Developer Dashboard. Select Create store to proceed.
-
Complete the store setup by following the instructions. You can customize store settings as needed.
4. Create a new app
To start developing on your store, you need to create an app.
-
In the home page of the new store, select Settings at the bottom.
-
Then proceed to the Apps section, and select Develop apps.
-
Select Allow custom app development.
-
Click Create an app, enter an app name, and confirm.
5. Generate an access token
-
Once the app is created, select Configure Admin API scopes and apply the necessary scopes for your REST APIs.
-
Click Install app to generate an Admin API access token.
-
Click Reveal token once to copy and save the token securely. This token will be required for authentication when using the Ballerina Shopify connector.
Your development store is now ready, and you can integrate it with Shopify using the Ballerina Shopify connector.
Quickstart
To use the Shopify connector in your Ballerina project, modify the .bal file as follows.
Step 1: Import the module
Import the ballerinax/shopify.admin module into your Ballerina project.
import ballerinax/shopify.admin as shopadmin;
Step 2: Instantiate a new connector
Create a shopadmin:Client instance with necessary configurations.
configurable string xShopifyAccessToken = ?; configurable string serviceUrl = ?; shopadmin:Client shopify = check new ( { xShopifyAccessToken }, serviceUrl );
Step 3: Invoke the connector operation
You can now utilize the operations available within the connector.
public function main() returns error? { shopadmin:CustomerResponse result = check shopify->createACustomer({ customer: { firstName: "John", lastName: "Doe", email: "john.doe@example.com" } }); }
Step 4: Run the Ballerina application
Use the following command to compile and run the Ballerina program.
bal run
Examples
The ballerinax/shopify.admin connector provides practical examples illustrating usage in various scenarios.
- Create new order : This is a guide to use the Shopify connector to connect to a Shopify store, register a customer, and place an order.
Clients
shopify.admin: Client
Isolated
As the primary way that apps interact with Shopify, the Admin API allows you to add your own features to the Shopify user experience. Considerations when using the Shopify Admin include:
- The Admin API supports both GraphQL and REST.
- This is a versioned API. Updates are released quarterly and supported API versions are listed in the release notes.
- Apps must explicitly request the relevant access scopes from the user during installation.
- Apps must authenticate to interact with the Admin API.
- The Admin API enforces rate limits on all requests. Note that there are different rate-limiting methods for GraphQL and REST. All apps connecting to the Admin API are subject to Shopify’s API Terms of Service.
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
getAListOfAccessScopes
Isolated FunctionRemote Function
function getAListOfAccessScopes(map<string|string[]> headers) returns AccessScopes|errorGet a list of access scopes
Return Type
- AccessScopes|error - List all scopes / List all scopes
retrieveAListOfStorefrontAccessTokensThatHaveBeenIssued
Isolated FunctionRemote Function
function retrieveAListOfStorefrontAccessTokensThatHaveBeenIssued(map<string|string[]> headers) returns StorefrontAccessTokens|errorRetrieves a list of storefront access tokens that have been issued
Return Type
- StorefrontAccessTokens|error - Retrieve a list of storefront access tokens that have been issued / Retrieve a list of storefront access tokens that have been issued
createANewStorefrontAccessToken
Isolated FunctionRemote Function
function createANewStorefrontAccessToken(ApiVersionStorefrontAccessTokensJsonBody payload, map<string|string[]> headers) returns StorefrontAccessToken|errorCreates a new StorefrontAccessToken
Parameters
- payload ApiVersionStorefrontAccessTokensJsonBody - Storefront access token details
Return Type
- StorefrontAccessToken|error - Create a new storefront access token / Create a new storefront access token
deleteAnExistingStorefrontAccessToken
Isolated FunctionRemote Function
function deleteAnExistingStorefrontAccessToken(string storefrontAccessTokenId, string payload, map<string|string[]> headers) returns string|errorDeletes an existing storefront access token
Parameters
- storefrontAccessTokenId string - The ID of the storefront access token
- payload string - Request body for deleting a storefront access token
Return Type
retrieveAListOfApplicationCharges
Isolated FunctionRemote Function
function retrieveAListOfApplicationCharges(map<string|string[]> headers, *RetrieveAListOfApplicationChargesQueries queries) returns ApplicationChargesList|errorRetrieves a list of application charges
Parameters
- queries *RetrieveAListOfApplicationChargesQueries - Queries to be sent with the request
Return Type
- ApplicationChargesList|error - Retrieves a list of application charges / Retrieves a list of application charges
createAnApplicationCharge
Isolated FunctionRemote Function
function createAnApplicationCharge(ApiVersionApplicationChargesJsonBody payload, map<string|string[]> headers) returns ApplicationCharge|errorCreates an application charge
Parameters
- payload ApiVersionApplicationChargesJsonBody - Application charge details
Return Type
- ApplicationCharge|error - Create a test charge that will not cause a credit card to be charged / Creates an application charge / Create a test charge that will not cause a credit card to be charged / Creates an application charge
retrieveAnApplicationCharge
Isolated FunctionRemote Function
function retrieveAnApplicationCharge(string applicationChargeId, map<string|string[]> headers, *RetrieveAnApplicationChargeQueries queries) returns ApplicationChargeResult|errorRetrieves an application charge
Parameters
- applicationChargeId string - The ID of the application charge
- queries *RetrieveAnApplicationChargeQueries - Queries to be sent with the request
Return Type
- ApplicationChargeResult|error - Retrieves an application charge / Retrieves an application charge
retrieveAllApplicationCredits
Isolated FunctionRemote Function
function retrieveAllApplicationCredits(map<string|string[]> headers, *RetrieveAllApplicationCreditsQueries queries) returns ApplicationCredits|errorRetrieves all application credits
Parameters
- queries *RetrieveAllApplicationCreditsQueries - Queries to be sent with the request
Return Type
- ApplicationCredits|error - Retrieves all application credits / Retrieves all application credits
retrieveASingleApplicationCredit
Isolated FunctionRemote Function
function retrieveASingleApplicationCredit(string aplicationCreditId, map<string|string[]> headers, *RetrieveASingleApplicationCreditQueries queries) returns ApplicationCredit|errorRetrieves a single application credit
Parameters
- aplicationCreditId string - The ID of the application credit
- queries *RetrieveASingleApplicationCreditQueries - Queries to be sent with the request
Return Type
- ApplicationCredit|error - Retrieves a single application credit / Retrieves a single application credit
retrieveAListOfRecurringApplicationCharges
Isolated FunctionRemote Function
function retrieveAListOfRecurringApplicationCharges(map<string|string[]> headers, *RetrieveAListOfRecurringApplicationChargesQueries queries) returns RecurringApplicationCharges|errorRetrieves a list of recurring application charges
Parameters
- queries *RetrieveAListOfRecurringApplicationChargesQueries - Queries to be sent with the request
Return Type
- RecurringApplicationCharges|error - Retrieves a list of recurring application charges / Retrieves a list of recurring application charges
createARecurringApplicationCharge
Isolated FunctionRemote Function
function createARecurringApplicationCharge(ApiVersionRecurringApplicationChargesJsonBody payload, map<string|string[]> headers) returns ApplicationChargeResponse|errorCreates a recurring application charge
Parameters
- payload ApiVersionRecurringApplicationChargesJsonBody - Recurring application charge details
Return Type
- ApplicationChargeResponse|error - Create a new charge with a trial period. The trial period will go into effect at the time the recurring charge is activated. / Create a new charge with terms and a capped amount / Create a recurring application charge / Create a recurring test charge that will not cause a credit card to be charged / Create a new charge with a trial period. The trial period will go into effect at the time the recurring charge is activated. / Create a new charge with terms and a capped amount / Create a recurring application charge / Create a recurring test charge that will not cause a credit card to be charged
retrieveASingleCharge
Isolated FunctionRemote Function
function retrieveASingleCharge(string recurringApplicationChargeId, map<string|string[]> headers, *RetrieveASingleChargeQueries queries) returns SingleCharge|errorRetrieves a single charge
Parameters
- recurringApplicationChargeId string - The ID of the recurring application charge
- queries *RetrieveASingleChargeQueries - Queries to be sent with the request
Return Type
- SingleCharge|error - Retrieves a single charge / Retrieves a single charge
cancelARecurringApplicationCharge
Isolated FunctionRemote Function
function cancelARecurringApplicationCharge(string recurringApplicationChargeId, string payload, map<string|string[]> headers) returns string|errorCancels a recurring application charge
Parameters
- recurringApplicationChargeId string - The ID of the recurring application charge
- payload string - Request body for cancelling a recurring application charge
Return Type
updateTheCappedAmountOfARecurringApplicationCharge
Isolated FunctionRemote Function
function updateTheCappedAmountOfARecurringApplicationCharge(string recurringApplicationChargeId, string payload, map<string|string[]> headers, *UpdateTheCappedAmountOfARecurringApplicationChargeQueries queries) returns CappedAmountCharge|errorUpdates the capped amount of a recurring application charge
Parameters
- recurringApplicationChargeId string - The ID of the recurring application charge
- payload string - Updated capped amount details
- queries *UpdateTheCappedAmountOfARecurringApplicationChargeQueries - Queries to be sent with the request
Return Type
- CappedAmountCharge|error - Increase the capped amount for a shop / Increase the capped amount for a shop
retrieveAListOfUsageCharges
Isolated FunctionRemote Function
function retrieveAListOfUsageCharges(string recurringApplicationChargeId, map<string|string[]> headers, *RetrieveAListOfUsageChargesQueries queries) returns UsageChargeList|errorRetrieves a list of usage charges
Parameters
- recurringApplicationChargeId string - The ID of the recurring application charge
- queries *RetrieveAListOfUsageChargesQueries - Queries to be sent with the request
Return Type
- UsageChargeList|error - Retrieve all usage charges / Retrieve all usage charges
createAUsageCharge
Isolated FunctionRemote Function
function createAUsageCharge(string recurringApplicationChargeId, RecurringApplicationChargeIdUsageChargesJsonBody payload, map<string|string[]> headers) returns UsageChargeResponse|errorCreates a usage charge
Parameters
- recurringApplicationChargeId string - The ID of the recurring application charge
- payload RecurringApplicationChargeIdUsageChargesJsonBody - Usage charge details
Return Type
- UsageChargeResponse|error - Create a new usage charge / Create a new usage charge
retrieveASingleCharge1
Isolated FunctionRemote Function
function retrieveASingleCharge1(string recurringApplicationChargeId, string usageChargeId, map<string|string[]> headers, *RetrieveASingleCharge1Queries queries) returns SingleUsageCharge|errorRetrieves a single charge
Parameters
- recurringApplicationChargeId string - The ID of the recurring application charge
- usageChargeId string - The ID of the usage charge
- queries *RetrieveASingleCharge1Queries - Queries to be sent with the request
Return Type
- SingleUsageCharge|error - Retrieves a single charge / Retrieves a single charge
retrieveAListOfCustomers
Isolated FunctionRemote Function
function retrieveAListOfCustomers(map<string|string[]> headers, *RetrieveAListOfCustomersQueries queries) returns Customers|errorRetrieves a list of customers
Parameters
- queries *RetrieveAListOfCustomersQueries - Queries to be sent with the request
createACustomer
Isolated FunctionRemote Function
function createACustomer(CreateCustomer payload, map<string|string[]> headers) returns CustomerResponse|errorCreates a customer
Parameters
- payload CreateCustomer - Customer details
Return Type
- CustomerResponse|error - Create a new customer record / Create a customer with password and password_confirmation and skip sending the welcome email / Create a customer with send_email_invite / Create a customer with a metafield / Create a new customer record / Create a customer with password and password_confirmation and skip sending the welcome email / Create a customer with send_email_invite / Create a customer with a metafield
createAnAccountActivationUrlForACustomer
Isolated FunctionRemote Function
function createAnAccountActivationUrlForACustomer(string customerId, CustomerInvite payload, map<string|string[]> headers) returns AccountActivationUrl|errorCreates an account activation URL for a customer
Parameters
- customerId string - The ID of the customer
- payload CustomerInvite - Account activation URL request details
Return Type
- AccountActivationUrl|error - Create an account activation URL for an invited or disabled customer / Create an account activation URL for an invited or disabled customer
sendAnAccountInviteToACustomer
Isolated FunctionRemote Function
function sendAnAccountInviteToACustomer(string customerId, CustomerIdSendInviteJsonBody payload, map<string|string[]> headers) returns AccountInvite|errorSends an account invite to a customer
Parameters
- customerId string - The ID of the customer
- payload CustomerIdSendInviteJsonBody - Account invite details
Return Type
- AccountInvite|error - Send a customized invite / Send the default invite / Send a customized invite / Send the default invite
retrieveASingleCustomer
Isolated FunctionRemote Function
function retrieveASingleCustomer(string customerId, map<string|string[]> headers, *RetrieveASingleCustomerQueries queries) returns CustomerResponse|errorRetrieves a single customer
Parameters
- customerId string - The ID of the customer
- queries *RetrieveASingleCustomerQueries - Queries to be sent with the request
Return Type
- CustomerResponse|error - Retrieves a single customer
updateACustomer
Isolated FunctionRemote Function
function updateACustomer(string customerId, UpdateCustomer payload, map<string|string[]> headers) returns CustomerResponse|errorUpdates a customer
Parameters
- customerId string - The ID of the customer
- payload UpdateCustomer - Updated customer details
Return Type
- CustomerResponse|error - Retrieves a single customer
deleteACustomer
Isolated FunctionRemote Function
function deleteACustomer(string customerId, string payload, map<string|string[]> headers) returns CustomerResponse|errorDeletes a customer.
Parameters
- customerId string - The ID of the customer
- payload string - Request body for deleting a customer
Return Type
- CustomerResponse|error - Retrieves a single customer
retrieveAllOrdersBelongingToACustomer
Isolated FunctionRemote Function
function retrieveAllOrdersBelongingToACustomer(string customerId, map<string|string[]> headers) returns Orders|errorRetrieves all orders belonging to a customer
Parameters
- customerId string - The ID of the customer
retrieveACountOfCustomers
Isolated FunctionRemote Function
function retrieveACountOfCustomers(map<string|string[]> headers) returns EventsCount|errorRetrieves a count of customers
Return Type
- EventsCount|error - Retrieve a count of customers
searchForCustomersThatMatchASuppliedQuery
Isolated FunctionRemote Function
function searchForCustomersThatMatchASuppliedQuery(map<string|string[]> headers, *SearchForCustomersThatMatchASuppliedQueryQueries queries) returns Customers|errorSearches for customers that match a supplied query
Parameters
- queries *SearchForCustomersThatMatchASuppliedQueryQueries - Queries to be sent with the request
retrieveAListOfAddressesForACustomer
Isolated FunctionRemote Function
function retrieveAListOfAddressesForACustomer(string customerId, map<string|string[]> headers) returns AddressList|errorRetrieves a list of addresses for a customer
Parameters
- customerId string - The ID of the customer
Return Type
- AddressList|error - Retrieve all of a customer’s addresses / Retrieve a limited number of addresses for a customer / Retrieve all of a customer’s addresses / Retrieve a limited number of addresses for a customer
createANewAddressForACustomer
Isolated FunctionRemote Function
function createANewAddressForACustomer(string customerId, CustomerIdAddressesJsonBody payload, map<string|string[]> headers) returns CustomerAddress|errorCreates a new address for a customer
Parameters
- customerId string - The ID of the customer
- payload CustomerIdAddressesJsonBody - Customer address details
Return Type
- CustomerAddress|error - Create a new address for a customer / Create a new address for a customer
retrieveDetailsForASingleCustomerAddress
Isolated FunctionRemote Function
function retrieveDetailsForASingleCustomerAddress(string customerId, string addressId, map<string|string[]> headers) returns SingleCustomerAddress|errorRetrieves details for a single customer address
Return Type
- SingleCustomerAddress|error - Retrieve a single customer address / Retrieve a single customer address
updateAnExistingCustomerAddress
Isolated FunctionRemote Function
function updateAnExistingCustomerAddress(string customerId, string addressId, AddressesaddressIdJsonBody payload, map<string|string[]> headers) returns PostalCodeResult|errorUpdates an existing customer address
Parameters
- customerId string - The ID of the customer
- addressId string - The ID of the address
- payload AddressesaddressIdJsonBody - Updated customer address details
Return Type
- PostalCodeResult|error - Update the postal code of a customer address / Update the postal code of a customer address
removeAnAddressFromACustomerSAddressList
Isolated FunctionRemote Function
function removeAnAddressFromACustomerSAddressList(string customerId, string addressId, string payload, map<string|string[]> headers) returns record {}|errorRemoves an address from a customer’s address list
Parameters
- customerId string - The ID of the customer
- addressId string - The ID of the address
- payload string - Request body for removing a customer address
Return Type
- record {}|error - Remove a customer address / Remove a customer address
setTheDefaultAddressForACustomer
Isolated FunctionRemote Function
function setTheDefaultAddressForACustomer(string customerId, string addressId, string payload, map<string|string[]> headers) returns CustomerDefaultAddress|errorSets the default address for a customer
Parameters
- customerId string - The ID of the customer
- addressId string - The ID of the address
- payload string - Request body for setting the default address
Return Type
- CustomerDefaultAddress|error - Set a default address for a customer / Set a default address for a customer
performBulkOperationsForMultipleCustomerAddresses
Isolated FunctionRemote Function
function performBulkOperationsForMultipleCustomerAddresses(string customerId, string payload, map<string|string[]> headers) returns json|errorPerforms bulk operations for multiple customer addresses
Return Type
- json|error - Destroy multiple customer addresses / Destroy multiple customer addresses
createADiscountCodeCreationJob
Isolated FunctionRemote Function
function createADiscountCodeCreationJob(string priceRuleId, PriceRuleIdBatchJsonBody payload, map<string|string[]> headers) returns DiscountCode|errorCreates a discount code creation job
Parameters
- priceRuleId string - The ID of the price rule
- payload PriceRuleIdBatchJsonBody - Discount code creation job details
Return Type
- DiscountCode|error - Create a discount code creation job / Create a discount code creation job
retrieveAListOfDiscountCodes
Isolated FunctionRemote Function
function retrieveAListOfDiscountCodes(string priceRuleId, map<string|string[]> headers) returns DiscountCodes|errorRetrieves a list of discount codes
Parameters
- priceRuleId string - The ID of the price rule
Return Type
- DiscountCodes|error - Retrieve a list of all discount codes / Retrieve a list of all discount codes
createADiscountCode
Isolated FunctionRemote Function
function createADiscountCode(string priceRuleId, PriceRuleIdDiscountCodesJsonBody payload, map<string|string[]> headers) returns CreateDiscountCode|errorCreates a discount code
Parameters
- priceRuleId string - The ID of the price rule
- payload PriceRuleIdDiscountCodesJsonBody - Discount code details
Return Type
- CreateDiscountCode|error - Create a discount code / Create a discount code
retrieveACountOfDiscountCodesForAShop
Isolated FunctionRemote Function
function retrieveACountOfDiscountCodesForAShop(map<string|string[]> headers, *RetrieveACountOfDiscountCodesForAShopQueries queries) returns EventsCount|errorRetrieves a count of discount codes for a shop
Parameters
- queries *RetrieveACountOfDiscountCodesForAShopQueries - Queries to be sent with the request
Return Type
- EventsCount|error - Retrieve a count of discount codes
retrieveTheLocationOfADiscountCode
Isolated FunctionRemote Function
Retrieves the location of a discount code
Return Type
- error? - Retrieve the location of a discount code
retrieveADiscountCodeCreationJob
Isolated FunctionRemote Function
function retrieveADiscountCodeCreationJob(string priceRuleId, string batchId, map<string|string[]> headers) returns DiscountCodeResponse|errorRetrieves a discount code creation job
Return Type
- DiscountCodeResponse|error - Retrieve a discount code creation job / Retrieve a discount code creation job
retrieveAListOfDiscountCodesForADiscountCodeCreationJob
Isolated FunctionRemote Function
function retrieveAListOfDiscountCodesForADiscountCodeCreationJob(string priceRuleId, string batchId, map<string|string[]> headers) returns DiscountCodeList|errorRetrieves a list of discount codes for a discount code creation job
Return Type
- DiscountCodeList|error - Retrieve a list of discount codes for a discount code creation job / Retrieve a list of discount codes for a discount code creation job
retrieveASingleDiscountCode
Isolated FunctionRemote Function
function retrieveASingleDiscountCode(string priceRuleId, string discountCodeId, map<string|string[]> headers) returns SingleDiscountCode|errorRetrieves a single discount code
Parameters
- priceRuleId string - The ID of the price rule
- discountCodeId string - The ID of the discount code
Return Type
- SingleDiscountCode|error - Retrieve a single discount code / Retrieve a single discount code
updateAnExistingDiscountCode
Isolated FunctionRemote Function
function updateAnExistingDiscountCode(string priceRuleId, string discountCodeId, DiscountCodesdiscountCodeIdJsonBody payload, map<string|string[]> headers) returns UpdateDiscountCode|errorUpdates an existing discount code
Parameters
- priceRuleId string - The ID of the price rule
- discountCodeId string - The ID of the discount code
- payload DiscountCodesdiscountCodeIdJsonBody - Updated discount code details
Return Type
- UpdateDiscountCode|error - Update the code for a discount / Update the code for a discount
deleteADiscountCode
Isolated FunctionRemote Function
function deleteADiscountCode(string priceRuleId, string discountCodeId, string payload, map<string|string[]> headers) returns string|errorDeletes a discount code
Parameters
- priceRuleId string - The ID of the price rule
- discountCodeId string - The ID of the discount code
- payload string - Request body for deleting a discount code
retrieveAListOfPriceRules
Isolated FunctionRemote Function
function retrieveAListOfPriceRules(map<string|string[]> headers, *RetrieveAListOfPriceRulesQueries queries) returns PriceRules|errorRetrieves a list of price rules
Parameters
- queries *RetrieveAListOfPriceRulesQueries - Queries to be sent with the request
Return Type
- PriceRules|error - Retrieve all price rules / Retrieve all price rules
createAPriceRule
Isolated FunctionRemote Function
function createAPriceRule(ApiVersionPriceRulesJsonBody payload, map<string|string[]> headers) returns PriceRule|errorCreates a price rule
Parameters
- payload ApiVersionPriceRulesJsonBody - Price rule details
Return Type
- PriceRule|error - Create a price rule that gives the buyer 15% off a specific collection / Create a price rule that gives a select group of customers $5 off their order / Create a price rule that gives the buyer free shipping on orders over $50.00 that can be used up to 20 times / Create a Buy X Get Y price rule that gives one free ipod touch if customer buys 2 ipods / Create a price rule that gives the buyer $10.00 off an order / Create a price rule that gives the buyer 15% off a specific collection / Create a price rule that gives a select group of customers $5 off their order / Create a price rule that gives the buyer free shipping on orders over $50.00 that can be used up to 20 times / Create a Buy X Get Y price rule that gives one free ipod touch if customer buys 2 ipods / Create a price rule that gives the buyer $10.00 off an order
retrieveASinglePriceRule
Isolated FunctionRemote Function
function retrieveASinglePriceRule(string priceRuleId, map<string|string[]> headers) returns SinglePriceRule|errorRetrieves a single price rule
Parameters
- priceRuleId string - The ID of the price rule
Return Type
- SinglePriceRule|error - Retrieve a single price rule by its ID / Retrieve a single price rule by its ID
updateAnExistingAPriceRule
Isolated FunctionRemote Function
function updateAnExistingAPriceRule(string priceRuleId, PriceRulespriceRuleIdJsonBody payload, map<string|string[]> headers) returns UpdatePriceRule|errorUpdates an existing a price rule
Parameters
- priceRuleId string - The ID of the price rule
- payload PriceRulespriceRuleIdJsonBody - Updated price rule details
Return Type
- UpdatePriceRule|error - Update the title of a price rule / Update the title of a price rule
removeAnExistingPriceRule
Isolated FunctionRemote Function
function removeAnExistingPriceRule(string priceRuleId, string payload, map<string|string[]> headers) returns string|errorRemove an existing PriceRule
Parameters
- priceRuleId string - The ID of the price rule
- payload string - Request body for removing a price rule
retrieveACountOfAllPriceRules
Isolated FunctionRemote Function
function retrieveACountOfAllPriceRules(map<string|string[]> headers) returns ObjectCount|errorRetrieves a count of all price rules
Return Type
- ObjectCount|error - Retrieve a count of all price rules / Retrieve a count of all price rules
retrieveAListOfEvents
Isolated FunctionRemote Function
function retrieveAListOfEvents(map<string|string[]> headers, *RetrieveAListOfEventsQueries queries) returns EventsList|errorRetrieves a list of events
Parameters
- queries *RetrieveAListOfEventsQueries - Queries to be sent with the request
Return Type
- EventsList|error - Retrieve a list of events related to products that were deleted / Retrieve a list of all events from a specific order / Retrieve all events after the specified ID / Retrieve an event after a specific ID using <code>since_id</code> / Retrieve a list of all events related to products and orders / Retrieve all events from a specific product / Retrieve a list of events that occured at the specified time / Retrieve a list of all events for a shop / Retrieve a list of events related to products that were deleted / Retrieve a list of all events from a specific order / Retrieve all events after the specified ID / Retrieve an event after a specific ID using <code>since_id</code> / Retrieve a list of all events related to products and orders / Retrieve all events from a specific product / Retrieve a list of events that occured at the specified time / Retrieve a list of all events for a shop
retrieveASingleEvent
Isolated FunctionRemote Function
function retrieveASingleEvent(string eventId, map<string|string[]> headers, *RetrieveASingleEventQueries queries) returns SingleEvent|errorRetrieves a single event
Parameters
- eventId string - The ID of the event
- queries *RetrieveASingleEventQueries - Queries to be sent with the request
Return Type
- SingleEvent|error - Retrieves a single event by its ID / Retrieves a single event by its ID
retrieveACountOfEvents
Isolated FunctionRemote Function
function retrieveACountOfEvents(map<string|string[]> headers, *RetrieveACountOfEventsQueries queries) returns EventsCount|errorRetrieves a count of events
Parameters
- queries *RetrieveACountOfEventsQueries - Queries to be sent with the request
Return Type
- EventsCount|error - Count all events / Count of the number of events since a particular time / Count all events / Count of the number of events since a particular time
retrieveAListOfGiftCards
Isolated FunctionRemote Function
function retrieveAListOfGiftCards(map<string|string[]> headers, *RetrieveAListOfGiftCardsQueries queries) returns GiftCardsList|errorRetrieves a list of gift cards
Parameters
- queries *RetrieveAListOfGiftCardsQueries - Queries to be sent with the request
Return Type
- GiftCardsList|error - Retrieve a list of all gift cards / Retrieve a list of all enabled gift cards / Retrieve a list of all gift cards / Retrieve a list of all enabled gift cards
createAGiftCard
Isolated FunctionRemote Function
function createAGiftCard(ApiVersionGiftCardsJsonBody payload, map<string|string[]> headers) returns GiftCard|errorCreates a gift card
Parameters
- payload ApiVersionGiftCardsJsonBody - Gift card details
Return Type
disableAGiftCard
Isolated FunctionRemote Function
function disableAGiftCard(string giftCardId, GiftCardIdDisableJsonBody payload, map<string|string[]> headers) returns DisableGiftCard|errorDisables a gift card
Parameters
- giftCardId string - The ID of the gift card
- payload GiftCardIdDisableJsonBody - Gift card disable request details
Return Type
- DisableGiftCard|error - Disable a gift card / Disable a gift card
retrieveASingleGiftCard
Isolated FunctionRemote Function
function retrieveASingleGiftCard(string giftCardId, map<string|string[]> headers, *RetrieveASingleGiftCardQueries queries) returns SingleGiftCard|errorRetrieves a single gift card
Parameters
- giftCardId string - The ID of the gift card
- queries *RetrieveASingleGiftCardQueries - Queries to be sent with the request
Return Type
- SingleGiftCard|error - Retrieve a single gift card / Retrieve a single gift card
updateAnExistingGiftCard
Isolated FunctionRemote Function
function updateAnExistingGiftCard(string giftCardId, GiftCardsgiftCardIdJsonBody payload, map<string|string[]> headers) returns UpdateGiftCard|errorUpdates an existing gift card
Parameters
- giftCardId string - The ID of the gift card
- payload GiftCardsgiftCardIdJsonBody - Updated gift card details
Return Type
- UpdateGiftCard|error - Update the expiry date of a gift card / Update the note of a gift card / Update the expiry date of a gift card / Update the note of a gift card
retrieveACountOfGiftCards
Isolated FunctionRemote Function
function retrieveACountOfGiftCards(map<string|string[]> headers, *RetrieveACountOfGiftCardsQueries queries) returns EventsCount|errorRetrieves a count of gift cards
Parameters
- queries *RetrieveACountOfGiftCardsQueries - Queries to be sent with the request
Return Type
- EventsCount|error - Retrieve a count of enabled gift cards / Retrieve a count of all gift cards / Retrieve a count of enabled gift cards / Retrieve a count of all gift cards
searchForGiftCards
Isolated FunctionRemote Function
function searchForGiftCards(map<string|string[]> headers, *SearchForGiftCardsQueries queries) returns GiftCardSearch|errorSearches for gift cards
Parameters
- queries *SearchForGiftCardsQueries - Queries to be sent with the request
Return Type
- GiftCardSearch|error - Retrieve all gift cards with the last characters "mnop" / Retrieve all gift cards with the last characters "mnop"
retrieveADetailedListForInventoryItemsByIds
Isolated FunctionRemote Function
function retrieveADetailedListForInventoryItemsByIds(map<string|string[]> headers, *RetrieveADetailedListForInventoryItemsByIdsQueries queries) returns error?Retrieves a detailed list for inventory items by IDs
Parameters
- queries *RetrieveADetailedListForInventoryItemsByIdsQueries - Queries to be sent with the request
Return Type
- error? - Retrieve inventory items by IDs
retrieveASingleInventoryItemById
Isolated FunctionRemote Function
function retrieveASingleInventoryItemById(string inventoryItemId, map<string|string[]> headers) returns InventoryItem|errorRetrieves a single inventory item by ID
Parameters
- inventoryItemId string - The ID of the inventory item
Return Type
- InventoryItem|error - Retrieve an inventory item by ID / Retrieve an inventory item by ID
updateAnExistingInventoryItem
Isolated FunctionRemote Function
function updateAnExistingInventoryItem(string inventoryItemId, InventoryItemsinventoryItemIdJsonBody payload, map<string|string[]> headers) returns UpdateInventoryItem|errorUpdates an existing inventory item
Parameters
- inventoryItemId string - The ID of the inventory item
- payload InventoryItemsinventoryItemIdJsonBody - Updated inventory item details
Return Type
- UpdateInventoryItem|error - Update an inventory item's SKU / Update an inventory item's unit cost / Update an inventory item's SKU / Update an inventory item's unit cost
adjustTheInventoryLevelOfAnInventoryItemAtALocation
Isolated FunctionRemote Function
function adjustTheInventoryLevelOfAnInventoryItemAtALocation(InventoryLevelsAdjustJsonBody payload, map<string|string[]> headers) returns InventoryLevel|errorAdjusts the inventory level of an inventory item at a location
Parameters
- payload InventoryLevelsAdjustJsonBody - Inventory level adjustment details
Return Type
- InventoryLevel|error - Adjust the available quantity of an inventory item by 5 at a single location / Adjust the available quantity of an inventory item by 5 at a single location
connectAnInventoryItemToALocation
Isolated FunctionRemote Function
function connectAnInventoryItemToALocation(InventoryLevelsConnectJsonBody payload, map<string|string[]> headers) returns ConnectInventoryItem|errorConnects an inventory item to a location
Parameters
- payload InventoryLevelsConnectJsonBody - Inventory item connection details
Return Type
- ConnectInventoryItem|error - Connect an inventory item to a location / Connect an inventory item to a location
setTheInventoryLevelForAnInventoryItemAtALocation
Isolated FunctionRemote Function
function setTheInventoryLevelForAnInventoryItemAtALocation(InventoryLevelsSetJsonBody payload, map<string|string[]> headers) returns AvailableInventory|errorSets the inventory level for an inventory item at a location
Parameters
- payload InventoryLevelsSetJsonBody - Inventory level details
Return Type
- AvailableInventory|error - Set the available inventory at a location / Set the available inventory at a location
retrieveAListOfInventoryLevels
Isolated FunctionRemote Function
function retrieveAListOfInventoryLevels(map<string|string[]> headers, *RetrieveAListOfInventoryLevelsQueries queries) returns InventoryLevels|errorRetrieves a list of inventory levels
Parameters
- queries *RetrieveAListOfInventoryLevelsQueries - Queries to be sent with the request
Return Type
- InventoryLevels|error - Retrieve inventory levels for the specified inventory items and locations / Retrieve inventory levels at a single location / Retrieve inventory levels for a single inventory item / Retrieve inventory levels for the specified inventory items and locations / Retrieve inventory levels at a single location / Retrieve inventory levels for a single inventory item
deleteAnInventoryLevelFromALocation
Isolated FunctionRemote Function
function deleteAnInventoryLevelFromALocation(string payload, map<string|string[]> headers) returns string|errorDeletes an inventory level from a location
Parameters
- payload string - Request body for deleting an inventory level
retrieveAListOfLocations
Isolated FunctionRemote Function
function retrieveAListOfLocations(map<string|string[]> headers) returns LocationList|errorRetrieves a list of locations
Return Type
- LocationList|error - Retrieve a list of all locations / Retrieve a list of all locations
retrieveASingleLocationByItsId
Isolated FunctionRemote Function
function retrieveASingleLocationByItsId(string locationId, map<string|string[]> headers) returns SingleLocation|errorRetrieves a single location by its ID
Parameters
- locationId string - The ID of the location
Return Type
- SingleLocation|error - Retrieve a single location / Retrieve a single location
retrieveAListOfInventoryLevelsForALocation
Isolated FunctionRemote Function
function retrieveAListOfInventoryLevelsForALocation(string locationId, map<string|string[]> headers) returns InventoryListResponse|errorRetrieves a list of inventory levels for a location.
Parameters
- locationId string - The ID of the location
Return Type
- InventoryListResponse|error - Retrieve a list of all inventory for a location by its ID / Retrieve a list of all inventory for a location by its ID
retrieveACountOfLocations
Isolated FunctionRemote Function
function retrieveACountOfLocations(map<string|string[]> headers) returns StoreLocationCount|errorRetrieves a count of locations
Return Type
- StoreLocationCount|error - Count all store locations / Count all store locations
retrieveAListOfAllMarketingEvents
Isolated FunctionRemote Function
function retrieveAListOfAllMarketingEvents(map<string|string[]> headers, *RetrieveAListOfAllMarketingEventsQueries queries) returns MarketingEvents|errorRetrieves a list of all marketing events
Parameters
- queries *RetrieveAListOfAllMarketingEventsQueries - Queries to be sent with the request
Return Type
- MarketingEvents|error - Retrieve all marketing events / Retrieve all marketing events
createAMarketingEvent
Isolated FunctionRemote Function
function createAMarketingEvent(ApiVersionMarketingEventsJsonBody payload, map<string|string[]> headers) returns CreateMarketingEvent|errorCreates a marketing event
Parameters
- payload ApiVersionMarketingEventsJsonBody - Marketing event details
Return Type
- CreateMarketingEvent|error - Create a marketing event / Create a marketing event
createMarketingEngagementsOnAMarketingEvent
Isolated FunctionRemote Function
function createMarketingEngagementsOnAMarketingEvent(string marketingEventId, MarketingEventIdEngagementsJsonBody payload, map<string|string[]> headers) returns Engagements|errorCreates marketing engagements on a marketing event
Parameters
- marketingEventId string - The ID of the marketing event
- payload MarketingEventIdEngagementsJsonBody - Marketing engagement details
Return Type
- Engagements|error - Add engagements to a marketing engagement / Add engagements to a marketing engagement
retrieveASingleMarketingEvent
Isolated FunctionRemote Function
function retrieveASingleMarketingEvent(string marketingEventId, map<string|string[]> headers) returns MarketingEvent|errorRetrieves a single marketing event
Parameters
- marketingEventId string - The ID of the marketing event
Return Type
- MarketingEvent|error - Retrieve a single marketing event by its ID / Retrieve a single marketing event by its ID
updateAMarketingEvent
Isolated FunctionRemote Function
function updateAMarketingEvent(string marketingEventId, MarketingEventsmarketingEventIdJsonBody payload, map<string|string[]> headers) returns UpdateMarketingEvent|errorUpdates a marketing event
Parameters
- marketingEventId string - The ID of the marketing event
- payload MarketingEventsmarketingEventIdJsonBody - Updated marketing event details
Return Type
- UpdateMarketingEvent|error - Update a marketing event. Can modify only timestamps, remote_id, and budget/currency. / Update a marketing event. Can modify only timestamps, remote_id, and budget/currency
deleteAMarketingEvent
Isolated FunctionRemote Function
function deleteAMarketingEvent(string marketingEventId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a marketing event
Parameters
- marketingEventId string - The ID of the marketing event
- payload string - Request body for deleting a marketing event
Return Type
- record {}|error - Delete a marketing event / Delete a marketing event
retrieveACountOfAllMarketingEvents
Isolated FunctionRemote Function
function retrieveACountOfAllMarketingEvents(map<string|string[]> headers) returns ObjectCount|errorRetrieves a count of all marketing events
Return Type
- ObjectCount|error - Retrieve a count all marketing events / Retrieve a count all marketing events
retrieveAListOfMetafieldsFromTheResourceSEndpoint
Isolated FunctionRemote Function
function retrieveAListOfMetafieldsFromTheResourceSEndpoint(string ownerId, string ownerResource, map<string|string[]> headers, *RetrieveAListOfMetafieldsFromTheResourceSEndpointQueries queries) returns MetafieldList|errorRetrieve a list of metafields from the resource's endpoint
Parameters
- ownerId string - The ID of the owner resource
- ownerResource string - The type of the owner resource
- queries *RetrieveAListOfMetafieldsFromTheResourceSEndpointQueries - Queries to be sent with the request
Return Type
- MetafieldList|error - Retrieve a list of metafields from the resource's endpoint
createAMetafield
Isolated FunctionRemote Function
function createAMetafield(string ownerId, string ownerResource, OwnerResourceMetafieldsJsonBody payload, map<string|string[]> headers) returns error?Create a metafield
Parameters
- ownerId string - The ID of the owner resource
- ownerResource string - The type of the owner resource
- payload OwnerResourceMetafieldsJsonBody - Metafield details
Return Type
- error? - Create a metafield
shopRetrieveAListOfMetafieldsFromTheResourceSEndpoint
Isolated FunctionRemote Function
function shopRetrieveAListOfMetafieldsFromTheResourceSEndpoint(map<string|string[]> headers, *ShopRetrieveAListOfMetafieldsFromTheResourceSEndpointQueries queries) returns error?[Shop] Retrieve a list of metafields from the resource's endpoint
Parameters
- queries *ShopRetrieveAListOfMetafieldsFromTheResourceSEndpointQueries - Queries to be sent with the request
Return Type
- error? - Retrieve metafields list
shopCreateAMetafield
Isolated FunctionRemote Function
function shopCreateAMetafield(ApiVersionMetafieldsJsonBody payload, map<string|string[]> headers) returns error?[Shop] Create a metafield
Parameters
- payload ApiVersionMetafieldsJsonBody - Metafield details
Return Type
- error? - Create a metafield
retrieveASpecificMetafield
Isolated FunctionRemote Function
function retrieveASpecificMetafield(string ownerId, string ownerResource, string metafieldId, map<string|string[]> headers, *RetrieveASpecificMetafieldQueries queries) returns MetafieldResponse|errorRetrieve a specific metafield
Parameters
- ownerId string - The ID of the owner resource
- ownerResource string - The type of the owner resource
- metafieldId string - The ID of the metafield
- queries *RetrieveASpecificMetafieldQueries - Queries to be sent with the request
Return Type
- MetafieldResponse|error - Retrieve a specific metafield
updateAMetafield
Isolated FunctionRemote Function
function updateAMetafield(string ownerId, string ownerResource, string metafieldId, string payload, map<string|string[]> headers) returns MetafieldResponse|errorUpdates a metafield
Parameters
- ownerId string - The ID of the owner resource
- ownerResource string - The type of the owner resource
- metafieldId string - The ID of the metafield
- payload string - Updated metafield details
Return Type
- MetafieldResponse|error - Update a metafield
deleteAMetafieldByItsId
Isolated FunctionRemote Function
function deleteAMetafieldByItsId(string ownerId, string ownerResource, string metafieldId, string payload, map<string|string[]> headers) returns error?Deletes a metafield by its ID
Parameters
- ownerId string - The ID of the owner resource
- ownerResource string - The type of the owner resource
- metafieldId string - The ID of the metafield
- payload string - Request body for deleting a metafield
Return Type
- error? - Delete a metafield
shopRetrieveASpecificMetafield
Isolated FunctionRemote Function
function shopRetrieveASpecificMetafield(string metafieldId, map<string|string[]> headers, *ShopRetrieveASpecificMetafieldQueries queries) returns MetafieldResponse|error[Shop] Retrieve a specific metafield
Parameters
- metafieldId string - The ID of the metafield
- queries *ShopRetrieveASpecificMetafieldQueries - Queries to be sent with the request
Return Type
- MetafieldResponse|error - Retrieve a specific metafield
shopUpdatesAMetafield
Isolated FunctionRemote Function
function shopUpdatesAMetafield(string metafieldId, string payload, map<string|string[]> headers) returns Metafield|error[Shop] Updates a metafield
shopDeletesAMetafieldByItsId
Isolated FunctionRemote Function
function shopDeletesAMetafieldByItsId(string metafieldId, string payload, map<string|string[]> headers) returns error?[Shop] Deletes a metafield by its ID.
Parameters
- metafieldId string - The ID of the metafield
- payload string - Request body for deleting a metafield
Return Type
- error? - Delete a metafield
retrieveACountOfAResourceSMetafields
Isolated FunctionRemote Function
function retrieveACountOfAResourceSMetafields(string ownerId, string ownerResource, map<string|string[]> headers) returns ObjectCount|errorRetrieve a count of a resource's metafields.
Parameters
- ownerId string - The ID of the owner resource
- ownerResource string - The type of the owner resource
Return Type
- ObjectCount|error - Retrieve a count of resource metafields
shopRetrieveACountOfAResourceSMetafields
Isolated FunctionRemote Function
function shopRetrieveACountOfAResourceSMetafields(map<string|string[]> headers) returns ObjectCount|error[Shop] Retrieve a count of a resource's metafields.
Return Type
- ObjectCount|error - Retrieve a count of shop metafields
listAllOfTheMobilePlatformApplicationsAssociatedWithTheApp
Isolated FunctionRemote Function
function listAllOfTheMobilePlatformApplicationsAssociatedWithTheApp(map<string|string[]> headers) returns MobilePlatformApplications|errorList all of the mobile platform applications associated with the app
Return Type
- MobilePlatformApplications|error - List all of the mobile platform applications associated with the app / List all of the mobile platform applications associated with the app
createAMobilePlatformApplication
Isolated FunctionRemote Function
function createAMobilePlatformApplication(ApiVersionMobilePlatformApplicationsJsonBody payload, map<string|string[]> headers) returns MobilePlatformApplication|errorCreate a mobile platform application
Parameters
- payload ApiVersionMobilePlatformApplicationsJsonBody - Mobile platform application details
Return Type
- MobilePlatformApplication|error - Create a mobile platform application for Android / Create mobile platform application for iOS / Create a mobile platform application for Android / Create mobile platform application for iOS
getAMobilePlatformApplication
Isolated FunctionRemote Function
function getAMobilePlatformApplication(string mobilePlatformApplicationId, map<string|string[]> headers) returns MobilePlatformApplicationResponse|errorGet a mobile platform application
Parameters
- mobilePlatformApplicationId string - The ID of the mobile platform application
Return Type
- MobilePlatformApplicationResponse|error - Get a mobile platform application / Get a mobile platform application
updateAMobilePlatformApplication
Isolated FunctionRemote Function
function updateAMobilePlatformApplication(string mobilePlatformApplicationId, MobilePlatformApplicationsmobilePlatformApplicationIdJsonBody payload, map<string|string[]> headers) returns MobilePlatformApplicationResponse|errorUpdate a mobile platform application
Parameters
- mobilePlatformApplicationId string - The ID of the mobile platform application
- payload MobilePlatformApplicationsmobilePlatformApplicationIdJsonBody - Updated mobile platform application details
Return Type
- MobilePlatformApplicationResponse|error - Update a mobile platform application
deleteAMobilePlatformApplication
Isolated FunctionRemote Function
function deleteAMobilePlatformApplication(string mobilePlatformApplicationId, string payload, map<string|string[]> headers) returns error?Delete a mobile platform application
Parameters
- mobilePlatformApplicationId string - The ID of the mobile platform application
- payload string - Request body for deleting a mobile platform application
Return Type
- error? - Delete a mobile platform application
retrieveAListOfAllArticlesFromABlog
Isolated FunctionRemote Function
function retrieveAListOfAllArticlesFromABlog(string blogId, map<string|string[]> headers, *RetrieveAListOfAllArticlesFromABlogQueries queries) returns Articles|errorRetrieves a list of all articles from a blog
Parameters
- blogId string - The ID of the blog
- queries *RetrieveAListOfAllArticlesFromABlogQueries - Queries to be sent with the request
Return Type
createAnArticleForABlog
Isolated FunctionRemote Function
function createAnArticleForABlog(string blogId, BlogIdArticlesJsonBody payload, map<string|string[]> headers) returns Article|errorCreates an article for a blog
Return Type
- Article|error - Create an article with a metafield / Create an article with an image, which will be downloaded by Shopify / Create an article with HTML markup for a blog / Create an article with a base64 encoded image / Create an unpublished article for a blog / Create an article with a metafield / Create an article with an image, which will be downloaded by Shopify / Create an article with HTML markup for a blog / Create an article with a base64 encoded image / Create an unpublished article for a blog
retrieveAListOfAllArticleAuthors
Isolated FunctionRemote Function
function retrieveAListOfAllArticleAuthors(map<string|string[]> headers) returns ArticleAuthors|errorRetrieves a list of all article authors
Return Type
- ArticleAuthors|error - Retrieve a list of all article authors / Retrieve a list of all article authors
retrieveAListOfAllArticleTags
Isolated FunctionRemote Function
function retrieveAListOfAllArticleTags(map<string|string[]> headers, *RetrieveAListOfAllArticleTagsQueries queries) returns TagsList|errorRetrieves a list of all article tags
Parameters
- queries *RetrieveAListOfAllArticleTagsQueries - Queries to be sent with the request
Return Type
- TagsList|error - Retrieve a list of all tags from a specific blog / Retrieve a list of the most popular tags / Retrieve a list of all tags for all articles / Retrieve a list of the most popular tags from a specific blog / Retrieve a list of all tags from a specific blog / Retrieve a list of the most popular tags / Retrieve a list of all tags for all articles / Retrieve a list of the most popular tags from a specific blog
receiveASingleArticle
Isolated FunctionRemote Function
function receiveASingleArticle(string blogId, string articleId, map<string|string[]> headers, *ReceiveASingleArticleQueries queries) returns SingleArticle|errorReceive a single Article
Parameters
- blogId string - The ID of the blog
- articleId string - The ID of the article
- queries *ReceiveASingleArticleQueries - Queries to be sent with the request
Return Type
- SingleArticle|error - Retrieve a single article / Retrieve a single article
updateAnArticle
Isolated FunctionRemote Function
function updateAnArticle(string blogId, string articleId, ArticlesarticleIdJsonBody payload, map<string|string[]> headers) returns SingleArticle|errorUpdates an article
Parameters
- blogId string - The ID of the blog
- articleId string - The ID of the article
- payload ArticlesarticleIdJsonBody - Updated article details
Return Type
- SingleArticle|error - Updates an article
deleteAnArticle
Isolated FunctionRemote Function
function deleteAnArticle(string blogId, string articleId, string payload, map<string|string[]> headers) returns record {}|errorDeletes an article
Parameters
- blogId string - The ID of the blog
- articleId string - The ID of the article
- payload string - Request body for deleting an article
Return Type
- record {}|error - Delete an existing article from a blog / Delete an existing article from a blog
retrieveACountOfAllArticlesFromABlog
Isolated FunctionRemote Function
function retrieveACountOfAllArticlesFromABlog(string blogId, map<string|string[]> headers, *RetrieveACountOfAllArticlesFromABlogQueries queries) returns ArticlesCount|errorRetrieves a count of all articles from a blog
Parameters
- blogId string - The ID of the blog
- queries *RetrieveACountOfAllArticlesFromABlogQueries - Queries to be sent with the request
Return Type
- ArticlesCount|error - Count all a blog's articles / Count all a blog's articles
retrieveAListOfAllArticleTagsFromASpecificBlog
Isolated FunctionRemote Function
function retrieveAListOfAllArticleTagsFromASpecificBlog(string blogId, map<string|string[]> headers, *RetrieveAListOfAllArticleTagsFromASpecificBlogQueries queries) returns Articles|errorRetrieves a list of all article tags from a specific blog
Parameters
- blogId string - The ID of the blog
- queries *RetrieveAListOfAllArticleTagsFromASpecificBlogQueries - Queries to be sent with the request
retrieveAListOfAssetsForATheme
Isolated FunctionRemote Function
function retrieveAListOfAssetsForATheme(string themeId, map<string|string[]> headers, *RetrieveAListOfAssetsForAThemeQueries queries) returns AssetsList|errorRetrieves a list of assets for a theme
Parameters
- themeId string - The ID of the theme
- queries *RetrieveAListOfAssetsForAThemeQueries - Queries to be sent with the request
Return Type
- AssetsList|error - Retrieve a list of all assets for a theme / Retrieve a theme image / Retrieve a Liquid template / Retrieve a list of all assets for a theme / Retrieve a theme image / Retrieve a Liquid template
createOrUpdatesAnAssetForATheme
Isolated FunctionRemote Function
function createOrUpdatesAnAssetForATheme(string themeId, ThemeIdAssetsJsonBody payload, map<string|string[]> headers) returns ImageAsset|errorCreates or updates an asset for a theme
Return Type
- ImageAsset|error - Create an image asset by providing a base64-encoded attachment / Create an image asset by providing a source URL from which to upload the image / Change an existing Liquid template's value / Duplicate an existing asset by providing a source key / Create an image asset by providing a base64-encoded attachment / Create an image asset by providing a source URL from which to upload the image / Change an existing Liquid template's value / Duplicate an existing asset by providing a source key
deleteAnAssetFromATheme
Isolated FunctionRemote Function
function deleteAnAssetFromATheme(string themeId, string payload, map<string|string[]> headers) returns DeleteAssetResponse|errorDeletes an asset from a theme
Parameters
- themeId string - The ID of the theme
- payload string - Request body for deleting a theme asset
Return Type
- DeleteAssetResponse|error - Delete an image from a theme / Delete an image from a theme
retrieveAListOfAllBlogs
Isolated FunctionRemote Function
function retrieveAListOfAllBlogs(map<string|string[]> headers, *RetrieveAListOfAllBlogsQueries queries) returns Blogs|errorRetrieve a list of all blogs
Parameters
- queries *RetrieveAListOfAllBlogsQueries - Queries to be sent with the request
Return Type
createANewBlog
Isolated FunctionRemote Function
function createANewBlog(ApiVersionBlogsJsonBody payload, map<string|string[]> headers) returns CreateBlogResponse|errorCreate a new Blog
Parameters
- payload ApiVersionBlogsJsonBody - Blog details
Return Type
- CreateBlogResponse|error - Create a new empty blog / Create a new empty blog with a metafield / Create a new empty blog / Create a new empty blog with a metafield
receiveASingleBlog
Isolated FunctionRemote Function
function receiveASingleBlog(string blogId, map<string|string[]> headers, *ReceiveASingleBlogQueries queries) returns SingleBlog|errorReceive a single Blog
Parameters
- blogId string - The ID of the blog
- queries *ReceiveASingleBlogQueries - Queries to be sent with the request
Return Type
- SingleBlog|error - Get a single blog / Get a single blog
modifyAnExistingBlog
Isolated FunctionRemote Function
function modifyAnExistingBlog(string blogId, BlogsblogIdJsonBody payload, map<string|string[]> headers) returns UpdateBlogResponse|errorModify an existing Blog
Return Type
- UpdateBlogResponse|error - Add a metafield to an existing blog / Update an existing blog title and handle and also activate comments / Update an existing blog title / Add a metafield to an existing blog / Update an existing blog title and handle and also activate comments / Update an existing blog title
removeAnExistingBlog
Isolated FunctionRemote Function
function removeAnExistingBlog(string blogId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing Blog
Return Type
- record {}|error - Remove an existing blog from a shop / Remove an existing blog from a shop
receiveACountOfAllBlogs
Isolated FunctionRemote Function
function receiveACountOfAllBlogs(map<string|string[]> headers) returns BlogsCount|errorReceive a count of all Blogs
Return Type
- BlogsCount|error - Get all blogs for a shop / Get all blogs for a shop
retrieveAListOfComments
Isolated FunctionRemote Function
function retrieveAListOfComments(map<string|string[]> headers, *RetrieveAListOfCommentsQueries queries) returns ArticleComments|errorRetrieves a list of comments
Parameters
- queries *RetrieveAListOfCommentsQueries - Queries to be sent with the request
Return Type
- ArticleComments|error - Retrieve all the comments for a certain article of a blog / Retrieve all the comments for this shop / Retrieve all comments for this shop after the specified ID / Retrieve all the comments for all the articles of a blog / Retrieve all the comments for a certain article of a blog / Retrieve all the comments for this shop / Retrieve all comments for this shop after the specified ID / Retrieve all the comments for all the articles of a blog
createACommentForAnArticle
Isolated FunctionRemote Function
function createACommentForAnArticle(ApiVersionCommentsJsonBody payload, map<string|string[]> headers) returns ArticleComment|errorCreates a comment for an article
Parameters
- payload ApiVersionCommentsJsonBody - Comment details
Return Type
- ArticleComment|error - Create a comment for an article of a blog using basic Textile markup / Create a comment for an article of a blog using basic Textile markup
approveAComment
Isolated FunctionRemote Function
function approveAComment(string commentId, record {} payload, map<string|string[]> headers) returns ApproveCommentResponse|errorApproves a comment
Parameters
- commentId string - The ID of the comment
- payload record {} - Comment approval request details
Return Type
- ApproveCommentResponse|error - Approve a comment and publish it to the blog / Approve a comment and publish it to the blog
markACommentAsNotSpam
Isolated FunctionRemote Function
function markACommentAsNotSpam(string commentId, record {} payload, map<string|string[]> headers) returns MarkCommentResponse|errorMarks a comment as not spam
Return Type
- MarkCommentResponse|error - Mark a comment as not spam, restoring it to an unapproved or published state / Mark a comment as not spam, restoring it to an unapproved or published state
removeAComment
Isolated FunctionRemote Function
function removeAComment(string commentId, record {} payload, map<string|string[]> headers) returns RemoveCommentResponse|errorRemoves a comment
Parameters
- commentId string - The ID of the comment
- payload record {} - Comment removal request details
Return Type
- RemoveCommentResponse|error - Remove a comment / Remove a comment
restoreAPreviouslyRemovedComment
Isolated FunctionRemote Function
function restoreAPreviouslyRemovedComment(string commentId, record {} payload, map<string|string[]> headers) returns RestoreRemoveComment|errorRestores a previously removed comment
Parameters
- commentId string - The ID of the comment
- payload record {} - Comment restoration request details
Return Type
- RestoreRemoveComment|error - Restore a removed comment / Restore a removed comment
markACommentAsSpam
Isolated FunctionRemote Function
function markACommentAsSpam(string commentId, record {} payload, map<string|string[]> headers) returns SpamCommentResponse|errorMarks a comment as spam
Return Type
- SpamCommentResponse|error - Mark a comment as spam / Mark a comment as spam
retrieveASingleCommentByItsId
Isolated FunctionRemote Function
function retrieveASingleCommentByItsId(string commentId, map<string|string[]> headers, *RetrieveASingleCommentByItsIdQueries queries) returns SingleCommentResponse|errorRetrieves a single comment by its ID
Parameters
- commentId string - The ID of the comment
- queries *RetrieveASingleCommentByItsIdQueries - Queries to be sent with the request
Return Type
- SingleCommentResponse|error - Retrieve a single comment / Retrieve a single comment
updateACommentOfAnArticle
Isolated FunctionRemote Function
function updateACommentOfAnArticle(string commentId, CommentscommentIdJsonBody payload, map<string|string[]> headers) returns UpdateCommentResponse|errorUpdates a comment of an article
Parameters
- commentId string - The ID of the comment
- payload CommentscommentIdJsonBody - Updated comment details
Return Type
- UpdateCommentResponse|error - Update the body of an existing comment / Update the body of an existing comment
retrieveACountOfComments
Isolated FunctionRemote Function
function retrieveACountOfComments(map<string|string[]> headers, *RetrieveACountOfCommentsQueries queries) returns BlogsCount|errorRetrieves a count of comments
Parameters
- queries *RetrieveACountOfCommentsQueries - Queries to be sent with the request
Return Type
- BlogsCount|error - Count all comments for a certain article of a blog / Count all the comments for all the articles of a blog / Count all the comments for this shop / Count all comments for a certain article of a blog / Count all the comments for all the articles of a blog / Count all the comments for this shop
retrieveAListOfPages
Isolated FunctionRemote Function
function retrieveAListOfPages(map<string|string[]> headers, *RetrieveAListOfPagesQueries queries) returns PagesListResponse|errorRetrieves a list of pages
Parameters
- queries *RetrieveAListOfPagesQueries - Queries to be sent with the request
Return Type
- PagesListResponse|error - Retrieve a list of all pages after the specified ID / Get all pages for a shop / Retrieve a list of all pages after the specified ID / Get all pages for a shop
createANewPage
Isolated FunctionRemote Function
function createANewPage(ApiVersionPagesJsonBody payload, map<string|string[]> headers) returns PageResponse|errorCreate a new Page
Parameters
- payload ApiVersionPagesJsonBody - Page details
Return Type
- PageResponse|error - Create a page with a metafield / Create a page with HTML markup / Create an unpublished page / Create a page with a metafield / Create a page with HTML markup / Create an unpublished page
retrieveASinglePageByItsId
Isolated FunctionRemote Function
function retrieveASinglePageByItsId(string pageId, map<string|string[]> headers, *RetrieveASinglePageByItsIdQueries queries) returns SinglePageResponse|errorRetrieves a single page by its ID
Parameters
- pageId string - The ID of the page
- queries *RetrieveASinglePageByItsIdQueries - Queries to be sent with the request
Return Type
- SinglePageResponse|error - Retrieve a single page / Retrieve a single page
updateAPage
Isolated FunctionRemote Function
function updateAPage(string pageId, PagespageIdJsonBody payload, map<string|string[]> headers) returns UpdatePageResponse|errorUpdates a page
Return Type
- UpdatePageResponse|error - Update an existing page completely / Add a metafield to a page / Show a hidden page / Update the body HTML of an existing page / Hide a published page / Update an existing page completely / Add a metafield to a page / Show a hidden page / Update the body HTML of an existing page / Hide a published page
deleteAPage
Isolated FunctionRemote Function
function deleteAPage(string pageId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a page
Return Type
- record {}|error - Delete a page / Delete a page
retrieveAPageCount
Isolated FunctionRemote Function
function retrieveAPageCount(map<string|string[]> headers, *RetrieveAPageCountQueries queries) returns ArticlesCount|errorRetrieves a page count
Parameters
- queries *RetrieveAPageCountQueries - Queries to be sent with the request
Return Type
- ArticlesCount|error - Retrieve a count of all pages / Retrieve a count of all pages
retrieveAListOfUrlRedirects
Isolated FunctionRemote Function
function retrieveAListOfUrlRedirects(map<string|string[]> headers, *RetrieveAListOfUrlRedirectsQueries queries) returns UrlList|errorRetrieves a list of URL redirects
Parameters
- queries *RetrieveAListOfUrlRedirectsQueries - Queries to be sent with the request
Return Type
createARedirect
Isolated FunctionRemote Function
function createARedirect(ApiVersionRedirectsJsonBody payload, map<string|string[]> headers) returns RedirectResponse|errorCreates a redirect
Parameters
- payload ApiVersionRedirectsJsonBody - Redirect details
Return Type
- RedirectResponse|error - Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain / Create a redirect / Create a redirect using a full URL for the path, which will be saved as an absolute path without a domain / Create a redirect
retrieveASingleRedirect
Isolated FunctionRemote Function
function retrieveASingleRedirect(string redirectId, map<string|string[]> headers, *RetrieveASingleRedirectQueries queries) returns SingleRedirect|errorRetrieves a single redirect
Parameters
- redirectId string - The ID of the redirect
- queries *RetrieveASingleRedirectQueries - Queries to be sent with the request
Return Type
- SingleRedirect|error - Retrieve a single redirect by its ID / Retrieve a single redirect by its ID
updateAnExistingRedirect
Isolated FunctionRemote Function
function updateAnExistingRedirect(string redirectId, RedirectsredirectIdJsonBody payload, map<string|string[]> headers) returns UpdateRedirect|errorUpdates an existing redirect
Parameters
- redirectId string - The ID of the redirect
- payload RedirectsredirectIdJsonBody - Updated redirect details
Return Type
- UpdateRedirect|error - Update the path URI of a redirect / Update both the path and target URIs of a redirect / Update the path URI of a redirect / Update both the path and target URIs of a redirect
deleteARedirect
Isolated FunctionRemote Function
function deleteARedirect(string redirectId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a redirect
Parameters
- redirectId string - The ID of the redirect
- payload string - Request body for deleting a redirect
Return Type
- record {}|error - Delete an existing redirect / Delete an existing redirect
retrieveACountOfUrlRedirects
Isolated FunctionRemote Function
function retrieveACountOfUrlRedirects(map<string|string[]> headers, *RetrieveACountOfUrlRedirectsQueries queries) returns EventsCount|errorRetrieves a count of URL redirects
Parameters
- queries *RetrieveACountOfUrlRedirectsQueries - Queries to be sent with the request
Return Type
- EventsCount|error - Count all redirects / Count all redirects
retrieveAListOfAllScriptTags
Isolated FunctionRemote Function
function retrieveAListOfAllScriptTags(map<string|string[]> headers, *RetrieveAListOfAllScriptTagsQueries queries) returns ScriptTagsList|errorRetrieves a list of all script tags
Parameters
- queries *RetrieveAListOfAllScriptTagsQueries - Queries to be sent with the request
Return Type
- ScriptTagsList|error - Retrieve a list of all script tags after the specified ID / Retrieve a list of all script tags / Retrieve a list of all script tags with a particular URL / Retrieve a list of all script tags after the specified ID / Retrieve a list of all script tags / Retrieve a list of all script tags with a particular URL
createANewScriptTag
Isolated FunctionRemote Function
function createANewScriptTag(ApiVersionScriptTagsJsonBody payload, map<string|string[]> headers) returns ScriptTagResponse|errorCreates a new script tag
Parameters
- payload ApiVersionScriptTagsJsonBody - Script tag details
Return Type
- ScriptTagResponse|error - Create a new script tag / Create a new script tag
retrieveASingleScriptTag
Isolated FunctionRemote Function
function retrieveASingleScriptTag(string scriptTagId, map<string|string[]> headers, *RetrieveASingleScriptTagQueries queries) returns SingleScriptTag|errorRetrieves a single script tag
Parameters
- scriptTagId string - The ID of the script tag
- queries *RetrieveASingleScriptTagQueries - Queries to be sent with the request
Return Type
- SingleScriptTag|error - Retrieve a single script tag by its ID / Retrieve a single script tag by its ID
updateAScriptTag
Isolated FunctionRemote Function
function updateAScriptTag(string scriptTagId, ScriptTagsscriptTagIdJsonBody payload, map<string|string[]> headers) returns UpdateScriptTagResponse|errorUpdates a script tag
Parameters
- scriptTagId string - The ID of the script tag
- payload ScriptTagsscriptTagIdJsonBody - Updated script tag details
Return Type
- UpdateScriptTagResponse|error - Update a script tag's URL / Update a script tag's URL
deleteAScriptTag
Isolated FunctionRemote Function
function deleteAScriptTag(string scriptTagId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a script tag
Parameters
- scriptTagId string - The ID of the script tag
- payload string - Request body for deleting a script tag
Return Type
- record {}|error - Delete an existing script tag / Delete an existing script tag
retrieveACountOfAllScriptTags
Isolated FunctionRemote Function
function retrieveACountOfAllScriptTags(map<string|string[]> headers, *RetrieveACountOfAllScriptTagsQueries queries) returns BlogsCount|errorRetrieves a count of all script tags
Parameters
- queries *RetrieveACountOfAllScriptTagsQueries - Queries to be sent with the request
Return Type
- BlogsCount|error - Retrieve a count of all script tags for your shop / Retrieve a count of all script tags for your shop
retrieveAListOfThemes
Isolated FunctionRemote Function
function retrieveAListOfThemes(map<string|string[]> headers, *RetrieveAListOfThemesQueries queries) returns ThemesList|errorRetrieves a list of themes
Parameters
- queries *RetrieveAListOfThemesQueries - Queries to be sent with the request
Return Type
- ThemesList|error - Retrieve a list of themes / Retrieve a list of themes
createATheme
Isolated FunctionRemote Function
function createATheme(ApiVersionThemesJsonBody payload, map<string|string[]> headers) returns CreateThemeResponse|errorCreates a theme
Parameters
- payload ApiVersionThemesJsonBody - Theme details
Return Type
- CreateThemeResponse|error - Create a theme that has a custom name and is published / Create a theme that has a custom name and is published
retrieveASingleTheme
Isolated FunctionRemote Function
function retrieveASingleTheme(string themeId, map<string|string[]> headers, *RetrieveASingleThemeQueries queries) returns SingleTheme|errorRetrieves a single theme
Parameters
- themeId string - The ID of the theme
- queries *RetrieveASingleThemeQueries - Queries to be sent with the request
Return Type
- SingleTheme|error - Retrieve a single theme / Retrieve a single theme
modifyAnExistingTheme
Isolated FunctionRemote Function
function modifyAnExistingTheme(string themeId, ThemesthemeIdJsonBody payload, map<string|string[]> headers) returns PublishThemeResponse|errorModify an existing Theme
Return Type
- PublishThemeResponse|error - Publish an unpublished theme / Update a theme's name / Publish an unpublished theme / Update a theme's name
removeAnExistingTheme
Isolated FunctionRemote Function
function removeAnExistingTheme(string themeId, string payload, map<string|string[]> headers) returns DeleteThemeResponse|errorRemove an existing Theme
Return Type
- DeleteThemeResponse|error - Delete a theme / Delete a theme
retrieveACountOfCheckouts
Isolated FunctionRemote Function
function retrieveACountOfCheckouts(map<string|string[]> headers, *RetrieveACountOfCheckoutsQueries queries) returns CheckoutCount|errorRetrieves a count of checkouts
Parameters
- queries *RetrieveACountOfCheckoutsQueries - Queries to be sent with the request
Return Type
- CheckoutCount|error - Count all checkouts / Count all checkouts
retrieveAListOfAbandonedCheckouts
Isolated FunctionRemote Function
function retrieveAListOfAbandonedCheckouts(map<string|string[]> headers, *RetrieveAListOfAbandonedCheckoutsQueries queries) returns AbandonedCheckouts|errorRetrieves a list of abandoned checkouts
Parameters
- queries *RetrieveAListOfAbandonedCheckoutsQueries - Queries to be sent with the request
Return Type
- AbandonedCheckouts|error - Retrieve all abandoned checkouts / Retrieve all abandoned checkouts
createACheckout
Isolated FunctionRemote Function
function createACheckout(ApiVersionCheckoutsJsonBody payload, map<string|string[]> headers) returns CreateCheckoutResponse|errorCreates a checkout
Parameters
- payload ApiVersionCheckoutsJsonBody - Checkout details
Return Type
- CreateCheckoutResponse|error - Create a checkout with a product variant and quantity / Create a checkout without any line items / Create a checkout with a product variant and quantity / Create a checkout without any line items
retrieveAListOfDraftOrders
Isolated FunctionRemote Function
function retrieveAListOfDraftOrders(map<string|string[]> headers, *RetrieveAListOfDraftOrdersQueries queries) returns DraftOrders|errorRetrieves a list of draft orders
Parameters
- queries *RetrieveAListOfDraftOrdersQueries - Queries to be sent with the request
Return Type
- DraftOrders|error - List all draft orders / List all draft orders
createANewDraftOrder
Isolated FunctionRemote Function
function createANewDraftOrder(ApiVersionDraftOrdersJsonBody payload, map<string|string[]> headers) returns CreateDraftOrder|errorCreate a new DraftOrder
Parameters
- payload ApiVersionDraftOrdersJsonBody - Draft order details
Return Type
- CreateDraftOrder|error - <span id="create-a-percent-discount-on-a-line-item-{{ current_version }}">Create a draft order with a percent discount on a line item</span> / Create a simple draft order with only a product variant ID. / <span id="create-a-draft-order-with-a-discount-{{ current_version }}">Create a draft order with a discount</span> / <span id="create-custom-draft-order-{{ current_version }}">Create custom draft order</span> / Create a draft order with a discounted line item / <span id="create-a-percent-discount-on-a-line-item-{{ current_version }}">Create a draft order with a percent discount on a line item</span> / Create a simple draft order with only a product variant ID. / <span id="create-a-draft-order-with-a-discount-{{ current_version }}">Create a draft order with a discount</span> / <span id="create-custom-draft-order-{{ current_version }}">Create custom draft order</span> / Create a draft order with a discounted line item
sendAnInvoice
Isolated FunctionRemote Function
function sendAnInvoice(string draftOrderId, DraftOrderIdSendInvoiceJsonBody payload, map<string|string[]> headers) returns InvoiceResponse|errorSend an invoice
Parameters
- draftOrderId string - The ID of the draft order
- payload DraftOrderIdSendInvoiceJsonBody - Invoice details
Return Type
- InvoiceResponse|error - Send a customized invoice / Send the default invoice / Send a customized invoice / Send the default invoice
receiveASingleDraftOrder
Isolated FunctionRemote Function
function receiveASingleDraftOrder(string draftOrderId, map<string|string[]> headers, *ReceiveASingleDraftOrderQueries queries) returns SingleDraftOrder|errorReceive a single DraftOrder
Parameters
- draftOrderId string - The ID of the draft order
- queries *ReceiveASingleDraftOrderQueries - Queries to be sent with the request
Return Type
- SingleDraftOrder|error - Get a representation of a single draft order / Get a representation of a single draft order
modifyAnExistingDraftOrder
Isolated FunctionRemote Function
function modifyAnExistingDraftOrder(string draftOrderId, DraftOrdersdraftOrderIdJsonBody payload, map<string|string[]> headers) returns ModifyDraftOrder|errorModify an existing DraftOrder
Parameters
- draftOrderId string - The ID of the draft order
- payload DraftOrdersdraftOrderIdJsonBody - Updated draft order details
Return Type
- ModifyDraftOrder|error - <span id="set-discount-on-a-draft-order-{{ current_version }}">Set a discount on a draft order</span> / Add a note to a draft order / <span id="set-discount-on-a-draft-order-{{ current_version }}">Set a discount on a draft order</span> / Add a note to a draft order
removeAnExistingDraftOrder
Isolated FunctionRemote Function
function removeAnExistingDraftOrder(string draftOrderId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing DraftOrder
Parameters
- draftOrderId string - The ID of the draft order
- payload string - Request body for removing a draft order
Return Type
- record {}|error - Permanently delete a draft order / Permanently delete a draft order
receiveACountOfAllDraftOrders
Isolated FunctionRemote Function
function receiveACountOfAllDraftOrders(map<string|string[]> headers, *ReceiveACountOfAllDraftOrdersQueries queries) returns StoreLocationCount|errorReceive a count of all DraftOrders
Parameters
- queries *ReceiveACountOfAllDraftOrdersQueries - Queries to be sent with the request
Return Type
- StoreLocationCount|error - Count all draft orders / Count all draft orders
completeADraftOrder
Isolated FunctionRemote Function
function completeADraftOrder(string draftOrderId, string payload, map<string|string[]> headers) returns CompleteDraftOrder|errorComplete a draft order
Parameters
- draftOrderId string - The ID of the draft order
- payload string - Request body for completing a draft order
Return Type
- CompleteDraftOrder|error - Complete a draft order, marking it as paid / Complete a draft order, marking it as pending / Complete a draft order, marking it as paid / Complete a draft order, marking it as pending
retrieveAListOfOrders
Isolated FunctionRemote Function
function retrieveAListOfOrders(map<string|string[]> headers, *RetrieveAListOfOrdersQueries queries) returns OrdersList|errorRetrieves a list of orders
Parameters
- queries *RetrieveAListOfOrdersQueries - Queries to be sent with the request
Return Type
- OrdersList|error - Retrieve all orders but show only certain properties / Retrieve specific orders / Retrieve orders that have authorized payments ready to be captured / Retrieve all orders / Retrieve orders last updated after 2005-07-31 15:57:11 in the EDT timezone / Retrieve all orders after the specified ID / Retrieve all orders but show only certain properties / Retrieve specific orders / Retrieve orders that have authorized payments ready to be captured / Retrieve all orders / Retrieve orders last updated after 2005-07-31 15:57:11 in the EDT timezone / Retrieve all orders after the specified ID
createAnOrder
Isolated FunctionRemote Function
function createAnOrder(CreateOrder payload, map<string|string[]> headers) returns OrderResponse|errorCreate an order
Parameters
- payload CreateOrder - Order details
Return Type
- OrderResponse|error - Create a partially paid order with a new customer and addresses / Create a comprehensive order / Create an order with tax lines split across taxable line items / Create a simple order with only a product variant ID / Create a simple order without sending an order receipt or a fulfillment receipt / Create a simple order, sending an order confirmation and a shipping confirmation to the customer / Create a pending order with an existing customer / Create a simple order and fulfill it / Create a partially paid order with a new customer and addresses / Create a comprehensive order / Create an order with tax lines split across taxable line items / Create a simple order with only a product variant ID / Create a simple order without sending an order receipt or a fulfillment receipt / Create a simple order, sending an order confirmation and a shipping confirmation to the customer / Create a pending order with an existing customer / Create a simple order and fulfill it
cancelAnOrder
Isolated FunctionRemote Function
function cancelAnOrder(string orderId, record {} payload, map<string|string[]> headers) returns OrderResponse|errorCancel an order
Return Type
- OrderResponse|error - Cancel an order
closeAnOrder
Isolated FunctionRemote Function
function closeAnOrder(string orderId, record {} payload, map<string|string[]> headers) returns CloseOrderResponse|errorClose an order
Return Type
- CloseOrderResponse|error - Close an order / Close an order
reOpenAClosedOrder
Isolated FunctionRemote Function
function reOpenAClosedOrder(string orderId, record {} payload, map<string|string[]> headers) returns ReopenCloseOrder|errorRe-open a closed order
Return Type
- ReopenCloseOrder|error - Re-open a closed order / Re-open a closed order
retrieveASpecificOrder
Isolated FunctionRemote Function
function retrieveASpecificOrder(string orderId, map<string|string[]> headers) returns SingleOrderResponse|errorRetrieves a specific order
Parameters
- orderId string - The ID of the order
Return Type
- SingleOrderResponse|error - Retrieve a single order / Get only particular fields / Retrieve a single order / Get only particular fields
updateAnOrder
Isolated FunctionRemote Function
function updateAnOrder(string orderId, UpdateOrder payload, map<string|string[]> headers) returns UpdateOrderResponse|errorUpdates an order
Return Type
- UpdateOrderResponse|error - Add note attributes to an order / Update the shipping address of an order / Update an order's tags / Add a note to order / Change an order's phone number / Add a metafield to an order / Change an order's email address / Remove the customer from an order / Change whether the buyer accepts marketing / Add note attributes to an order / Update the shipping address of an order / Update an order's tags / Add a note to order / Change an order's phone number / Add a metafield to an order / Change an order's email address / Remove the customer from an order / Change whether the buyer accepts marketing
deleteAnOrder
Isolated FunctionRemote Function
function deleteAnOrder(string orderId, string payload, map<string|string[]> headers) returns record {}|errorDeletes an order
Return Type
- record {}|error - Delete an order / Delete an order
retrieveAnOrderCount
Isolated FunctionRemote Function
function retrieveAnOrderCount(map<string|string[]> headers, *RetrieveAnOrderCountQueries queries) returns ObjectCount|errorRetrieves an order count
Parameters
- queries *RetrieveAnOrderCountQueries - Queries to be sent with the request
Return Type
- ObjectCount|error - Count orders that have authorized payments ready to be captured / Count all orders / Count orders that have authorized payments ready to be captured / Count all orders
retrieveAListOfAllOrderRisksForAnOrder
Isolated FunctionRemote Function
function retrieveAListOfAllOrderRisksForAnOrder(string orderId, map<string|string[]> headers) returns OrderRisks|errorRetrieves a list of all order risks for an order
Parameters
- orderId string - The ID of the order
Return Type
- OrderRisks|error - Retrieve all order risks for an order / Retrieve all order risks for an order
createAnOrderRiskForAnOrder
Isolated FunctionRemote Function
function createAnOrderRiskForAnOrder(string orderId, CreateOrderRisk payload, map<string|string[]> headers) returns CreateOrderRisk|errorCreates an order risk for an order
Return Type
- CreateOrderRisk|error - Create an order risk showing a fraud risk for proxy detection / Create an order risk showing a fraud risk for proxy detection
retrieveASingleOrderRiskByItsId
Isolated FunctionRemote Function
function retrieveASingleOrderRiskByItsId(string orderId, string riskId, map<string|string[]> headers) returns SingleOrderRisk|errorRetrieves a single order risk by its ID
Return Type
- SingleOrderRisk|error - Retrieve a single order risk / Retrieve a single order risk
updateAnOrderRisk
Isolated FunctionRemote Function
function updateAnOrderRisk(string orderId, string riskId, UpdateOrderRisk payload, map<string|string[]> headers) returns OrderRiskObject|errorUpdates an order risk
Parameters
- orderId string - The ID of the order
- riskId string - The ID of the order risk
- payload UpdateOrderRisk - Updated order risk details
Return Type
- OrderRiskObject|error - Update an existing order risk for an order / Update an existing order risk for an order
deleteAnOrderRiskForAnOrder
Isolated FunctionRemote Function
function deleteAnOrderRiskForAnOrder(string orderId, string riskId, string payload, map<string|string[]> headers) returns record {}|errorDeletes an order risk for an order
Parameters
- orderId string - The ID of the order
- riskId string - The ID of the order risk
- payload string - Request body for deleting an order risk
Return Type
- record {}|error - Delete an order risk for an order / Delete an order risk for an order
retrieveAListOfRefundsForAnOrder
Isolated FunctionRemote Function
function retrieveAListOfRefundsForAnOrder(string orderId, map<string|string[]> headers, *RetrieveAListOfRefundsForAnOrderQueries queries) returns Refunds|errorRetrieves a list of refunds for an order
Parameters
- orderId string - The ID of the order
- queries *RetrieveAListOfRefundsForAnOrderQueries - Queries to be sent with the request
Return Type
createARefund
Isolated FunctionRemote Function
function createARefund(string orderId, CreateRefund payload, map<string|string[]> headers) returns RefundObject|errorCreates a refund
Return Type
- RefundObject|error - Create a refund for an order / Refund a specific amount of shipping / Create a refund for an order / Refund a specific amount of shipping
calculateARefund
Isolated FunctionRemote Function
function calculateARefund(string orderId, RefundsCalculateJsonBody payload, map<string|string[]> headers) returns CalculateRefund|errorCalculates a refund
Parameters
- orderId string - The ID of the order
- payload RefundsCalculateJsonBody - Refund calculation details
Return Type
- CalculateRefund|error - Calculate the refund for a line item and shipping / Calculate a refund for a partial amount of shipping / Calculate the refund without specifying currency / Calculate the refund for a line item and shipping / Calculate a refund for a partial amount of shipping / Calculate the refund without specifying currency
retrieveASpecificRefund
Isolated FunctionRemote Function
function retrieveASpecificRefund(string orderId, string refundId, map<string|string[]> headers, *RetrieveASpecificRefundQueries queries) returns RefundResponse|errorRetrieves a specific refund
Parameters
- orderId string - The ID of the order
- refundId string - The ID of the refund
- queries *RetrieveASpecificRefundQueries - Queries to be sent with the request
Return Type
- RefundResponse|error - Retrieve a specific refund / Retrieve a specific refund
retrieveAListOfTransactions
Isolated FunctionRemote Function
function retrieveAListOfTransactions(string orderId, map<string|string[]> headers, *RetrieveAListOfTransactionsQueries queries) returns TransactionsList|errorRetrieves a list of transactions
Parameters
- orderId string - The ID of the order
- queries *RetrieveAListOfTransactionsQueries - Queries to be sent with the request
Return Type
- TransactionsList|error - Retrieve an order's transactions / Retrieve an order's transactions after a specified ID / Retrieve an order's transactions / Retrieve an order's transactions after a specified ID
createATransactionForAnOrder
Isolated FunctionRemote Function
function createATransactionForAnOrder(string orderId, CreateTransaction payload, map<string|string[]> headers) returns TransactionObject|errorCreates a transaction for an order
Return Type
- TransactionObject|error - Capture the full amount for an authorized order, and associate the capture with an authorization by including its authorization code / Create a test transaction. / Capture a specified amount on an authorized order, and associate the capture with an authorization by including its ID / Capture the full amount for an authorized order, and associate the capture with an authorization by including its authorization code / Create a test transaction. / Capture a specified amount on an authorized order, and associate the capture with an authorization by including its ID
retrieveASpecificTransaction
Isolated FunctionRemote Function
function retrieveASpecificTransaction(string orderId, string transactionId, map<string|string[]> headers, *RetrieveASpecificTransactionQueries queries) returns TransactionResponse|errorRetrieves a specific transaction
Parameters
- orderId string - The ID of the order
- transactionId string - The ID of the transaction
- queries *RetrieveASpecificTransactionQueries - Queries to be sent with the request
Return Type
- TransactionResponse|error - Retrieve a specific transaction for an order / Retrieve a specific transaction for an order
retrieveACountOfAnOrderSTransactions
Isolated FunctionRemote Function
function retrieveACountOfAnOrderSTransactions(string orderId, map<string|string[]> headers) returns EventsCount|errorRetrieves a count of an order's transactions
Parameters
- orderId string - The ID of the order
Return Type
- EventsCount|error - Count an order's transactions / Count an order's transactions
retrieveAListOfAllUsers
Isolated FunctionRemote Function
Retrieves a list of all users
retrieveASingleUser
Isolated FunctionRemote Function
Retrieves a single user
Parameters
- userId string - The ID of the user
Return Type
- SingleUser|error - Retrieve a single user / Retrieve a single user
retrieveTheCurrentlyLoggedInUser
Isolated FunctionRemote Function
function retrieveTheCurrentlyLoggedInUser(map<string|string[]> headers) returns SingleUser|errorRetrieves the currently logged-in user
Return Type
- SingleUser|error - Retrieve the the currently logged-in user / Retrieve the the currently logged-in user
retrieveAListOfCollects
Isolated FunctionRemote Function
function retrieveAListOfCollects(map<string|string[]> headers, *RetrieveAListOfCollectsQueries queries) returns CollectsList|errorRetrieves a list of collects
Parameters
- queries *RetrieveAListOfCollectsQueries - Queries to be sent with the request
Return Type
- CollectsList|error - Retrieve only collects for a certain product / Retrieve all collects for the shop / Retrieve only collects for a certain collection / Retrieve only collects for a certain product / Retrieve all collects for the shop / Retrieve only collects for a certain collection
addAProductToACustomCollection
Isolated FunctionRemote Function
function addAProductToACustomCollection(ApiVersionCollectsJsonBody payload, map<string|string[]> headers) returns ProductToCollectionResponse|errorAdds a product to a custom collection
Parameters
- payload ApiVersionCollectsJsonBody - Collect details
Return Type
- ProductToCollectionResponse|error - Create a new link between an existing product and an existing collection / Create a new link between an existing product and an existing collection
retrieveASpecificCollectByItsId
Isolated FunctionRemote Function
function retrieveASpecificCollectByItsId(string collectId, map<string|string[]> headers, *RetrieveASpecificCollectByItsIdQueries queries) returns CollectResponse|errorRetrieves a specific collect by its ID
Parameters
- collectId string - The ID of the collect
- queries *RetrieveASpecificCollectByItsIdQueries - Queries to be sent with the request
Return Type
- CollectResponse|error - Retrieve a collect with a certain ID / Retrieve a collect with a certain ID
removeAProductFromACollection
Isolated FunctionRemote Function
function removeAProductFromACollection(string collectId, string payload, map<string|string[]> headers) returns record {}|errorRemoves a product from a collection
Parameters
- collectId string - The ID of the collect
- payload string - Request body for removing a product from a collection
Return Type
- record {}|error - Delete the link between a product an a collection / Delete the link between a product an a collection
retrieveACountOfCollects
Isolated FunctionRemote Function
function retrieveACountOfCollects(map<string|string[]> headers) returns ObjectCount|errorRetrieves a count of collects
Return Type
- ObjectCount|error - Count only collects for a certain collection / Count only collects for a certain product / Count all collects for the shop / Count only collects for a certain collection / Count only collects for a certain product / Count all collects for the shop
retrieveASingleCollection
Isolated FunctionRemote Function
function retrieveASingleCollection(string collectionId, map<string|string[]> headers, *RetrieveASingleCollectionQueries queries) returns SingleCollection|errorRetrieves a single collection
Parameters
- collectionId string - The ID of the collection
- queries *RetrieveASingleCollectionQueries - Queries to be sent with the request
Return Type
- SingleCollection|error - Retrieve a specific collection by its ID / Retrieve a specific collection by its ID
retrieveAListOfProductsBelongingToACollection
Isolated FunctionRemote Function
function retrieveAListOfProductsBelongingToACollection(string collectionId, map<string|string[]> headers, *RetrieveAListOfProductsBelongingToACollectionQueries queries) returns ProductsList|errorRetrieve a list of products belonging to a collection
Parameters
- collectionId string - The ID of the collection
- queries *RetrieveAListOfProductsBelongingToACollectionQueries - Queries to be sent with the request
Return Type
- ProductsList|error - Retrieve a list of products belonging to a collection / Retrieve a list of products belonging to a collection
retrieveAListOfCustomCollections
Isolated FunctionRemote Function
function retrieveAListOfCustomCollections(map<string|string[]> headers, *RetrieveAListOfCustomCollectionsQueries queries) returns CollectionList|errorRetrieves a list of custom collections
Parameters
- queries *RetrieveAListOfCustomCollectionsQueries - Queries to be sent with the request
Return Type
- CollectionList|error - Retrieve all collections / Retrieve all collections after the specified ID / Retrieve a list of specific custom collections / Retrieve all custom collections that contain a given product / Retrieve all collections / Retrieve all collections after the specified ID / Retrieve a list of specific custom collections / Retrieve all custom collections that contain a given product
createACustomCollection
Isolated FunctionRemote Function
function createACustomCollection(ApiVersionCustomCollectionsJsonBody payload, map<string|string[]> headers) returns CreateCollection|errorCreates a custom collection
Parameters
- payload ApiVersionCustomCollectionsJsonBody - Custom collection details
Return Type
- CreateCollection|error - Create an unpublished custom collection / Create a custom collection / Create a collection that contains a product by including a collect / Create a custom collection with a base64-encoded image / Create a custom collection with a metafield / Create a custom collection with an image, which will be uploaded to Shopify / Create an unpublished custom collection / Create a custom collection / Create a collection that contains a product by including a collect / Create a custom collection with a base64-encoded image / Create a custom collection with a metafield / Create a custom collection with an image, which will be uploaded to Shopify
retrieveASingleCustomCollection
Isolated FunctionRemote Function
function retrieveASingleCustomCollection(string customCollectionId, map<string|string[]> headers, *RetrieveASingleCustomCollectionQueries queries) returns SingleCustomCollection|errorRetrieves a single custom collection
Parameters
- customCollectionId string - The ID of the custom collection
- queries *RetrieveASingleCustomCollectionQueries - Queries to be sent with the request
Return Type
- SingleCustomCollection|error - Retrieve a specific collection by its ID / Retrieve a specific collection by its ID
updateAnExistingCustomCollection
Isolated FunctionRemote Function
function updateAnExistingCustomCollection(string customCollectionId, CustomCollectionscustomCollectionIdJsonBody payload, map<string|string[]> headers) returns UpdateCustomCollection|errorUpdates an existing custom collection
Parameters
- customCollectionId string - The ID of the custom collection
- payload CustomCollectionscustomCollectionIdJsonBody - Updated custom collection details
Return Type
- UpdateCustomCollection|error - Update the description of a custom collection / Update a collection to remove its image / Update a collection with a new collection image / Update a collection with new alt text for its image / Publish a hidden collection / Add a collect to an existing collection by providing a product ID, and update an existing collect by its own ID to change its sort position / Add a metafield to an existing collection / Hide a published collection / Update the description of a custom collection / Update a collection to remove its image / Update a collection with a new collection image / Update a collection with new alt text for its image / Publish a hidden collection / Add a collect to an existing collection by providing a product ID, and update an existing collect by its own ID to change its sort position / Add a metafield to an existing collection / Hide a published collection
deleteACustomCollection
Isolated FunctionRemote Function
function deleteACustomCollection(string customCollectionId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a custom collection
Parameters
- customCollectionId string - The ID of the custom collection
- payload string - Request body for deleting a custom collection
Return Type
- record {}|error - Delete a custom collection / Delete a custom collection
retrieveACountOfCustomCollections
Isolated FunctionRemote Function
function retrieveACountOfCustomCollections(map<string|string[]> headers, *RetrieveACountOfCustomCollectionsQueries queries) returns BlogsCount|errorRetrieves a count of custom collections
Parameters
- queries *RetrieveACountOfCustomCollectionsQueries - Queries to be sent with the request
Return Type
- BlogsCount|error - Count all custom collections that contain a given product / Count all custom collections / Count all custom collections that contain a given product / Count all custom collections
retrieveAListOfProducts
Isolated FunctionRemote Function
function retrieveAListOfProducts(map<string|string[]> headers, *RetrieveAListOfProductsQueries queries) returns ProductsResponse|errorRetrieves a list of products
Parameters
- queries *RetrieveAListOfProductsQueries - Queries to be sent with the request
Return Type
- ProductsResponse|error - Retrieve all products, showing only some attributes / Retrieve all products with prices in selected presentment currencies / Retrieve all products that belong to a certain collection / Retrieve all products / Retrieve all products after the specified ID / Retrieve a list of specific products. / Retrieve all products, showing only some attributes / Retrieve all products with prices in selected presentment currencies / Retrieve all products that belong to a certain collection / Retrieve all products / Retrieve all products after the specified ID / Retrieve a list of specific products
createANewProduct
Isolated FunctionRemote Function
function createANewProduct(CreateProduct payload, map<string|string[]> headers) returns CreateProductResponse|errorCreates a new product
Parameters
- payload CreateProduct - Product details
Return Type
- CreateProductResponse|error - Create a new product with multiple product variants and multiple options / Create a new product with multiple product variants / Create a new product with the default variant and base64 encoded image / Create a product with a metafield / Create a new product with the default product variant / Create a new product with the default variant and a product image that will be downloaded by Shopify / Create a new unpublished product / Create a new product with multiple product variants and multiple options / Create a new product with multiple product variants / Create a new product with the default variant and base64 encoded image / Create a product with a metafield / Create a new product with the default product variant / Create a new product with the default variant and a product image that will be downloaded by Shopify / Create a new unpublished product
retrieveASingleProduct
Isolated FunctionRemote Function
function retrieveASingleProduct(string productId, map<string|string[]> headers, *RetrieveASingleProductQueries queries) returns SingleProduct|errorRetrieves a single product
Parameters
- productId string - The ID of the product
- queries *RetrieveASingleProductQueries - Queries to be sent with the request
Return Type
- SingleProduct|error - Retrieve only particular fields / Retrieve a single product by ID / Retrieve only particular fields / Retrieve a single product by ID
updateAProduct
Isolated FunctionRemote Function
function updateAProduct(string productId, UpdateProduct payload, map<string|string[]> headers) returns ProductObject|errorUpdates a product
Return Type
- ProductObject|error - Add a metafield to an existing product / Update a product by adding a new product image / Update a product by reordering product image / Update a product's title / Update a product by clearing product images / Hide a published product by changing the published attribute to false / Update a product's SEO title and description / Update a product and one of its variants / Update a product by reordering the product variants / Show a hidden product by changing the published attribute to true / Update a product's tags / Add a metafield to an existing product / Update a product by adding a new product image / Update a product by reordering product image / Update a product's title / Update a product by clearing product images / Hide a published product by changing the published attribute to false / Update a product's SEO title and description / Update a product and one of its variants / Update a product by reordering the product variants / Show a hidden product by changing the published attribute to true / Update a product's tags
deleteAProduct
Isolated FunctionRemote Function
function deleteAProduct(string productId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a product
Parameters
- productId string - The ID of the product
- payload string - Request body for deleting a product
Return Type
- record {}|error - Delete a product along with all its variants and images / Delete a product along with all its variants and images
retrieveACountOfProducts
Isolated FunctionRemote Function
function retrieveACountOfProducts(map<string|string[]> headers, *RetrieveACountOfProductsQueries queries) returns ObjectCount|errorRetrieves a count of products
Parameters
- queries *RetrieveACountOfProductsQueries - Queries to be sent with the request
Return Type
- ObjectCount|error - Retrieve a count of all products of a given collection / Retrieve a count of all products / Retrieve a count of all products of a given collection / Retrieve a count of all products
receiveAListOfAllProductImages
Isolated FunctionRemote Function
function receiveAListOfAllProductImages(string productId, map<string|string[]> headers, *ReceiveAListOfAllProductImagesQueries queries) returns ProductImages|errorReceive a list of all Product Images
Parameters
- productId string - The ID of the product
- queries *ReceiveAListOfAllProductImagesQueries - Queries to be sent with the request
Return Type
- ProductImages|error - Get all product images for a product / Get all product images for a product after a specified ID / Get all product images for a product / Get all product images for a product after a specified ID
createANewProductImage
Isolated FunctionRemote Function
function createANewProductImage(string productId, ProductIdImagesJsonBody payload, map<string|string[]> headers) returns CreateProductImage|errorCreate a new Product Image
Parameters
- productId string - The ID of the product
- payload ProductIdImagesJsonBody - Product image details
Return Type
- CreateProductImage|error - Create a new product image with included image data as attachment / Create a new product image and make it the main image / Create a new product image using a source URL that will be downloaded by Shopify / Create a new product image and attach it to product variants / <span id="metafield">Create a new product image with a metafield</span> / Create a new product image with included image data as attachment / Create a new product image and make it the main image / Create a new product image using a source URL that will be downloaded by Shopify / Create a new product image and attach it to product variants / <span id="metafield">Create a new product image with a metafield</span>
receiveASingleProductImage
Isolated FunctionRemote Function
function receiveASingleProductImage(string productId, string imageId, map<string|string[]> headers, *ReceiveASingleProductImageQueries queries) returns SingleProductImage|errorReceive a single Product Image
Parameters
- productId string - The ID of the product
- imageId string - The ID of the image
- queries *ReceiveASingleProductImageQueries - Queries to be sent with the request
Return Type
- SingleProductImage|error - Show product image / Show product image
modifyAnExistingProductImage
Isolated FunctionRemote Function
function modifyAnExistingProductImage(string productId, string imageId, ImagesimageIdJsonBody payload, map<string|string[]> headers) returns ModifyProductImage|errorModify an existing Product Image
Parameters
- productId string - The ID of the product
- imageId string - The ID of the image
- payload ImagesimageIdJsonBody - Updated product image details
Return Type
- ModifyProductImage|error - Modify an image; add a metafield / Modify an image; change its position and alt tag content / Modify an image; add it to product variants / Modify an image; add a metafield / Modify an image; change its position and alt tag content / Modify an image; add it to product variants
removeAnExistingProductImage
Isolated FunctionRemote Function
function removeAnExistingProductImage(string productId, string imageId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing Product Image
Parameters
- productId string - The ID of the product
- imageId string - The ID of the image
- payload string - Request body for removing a product image
Return Type
- record {}|error - Delete a product image / Delete a product image
receiveACountOfAllProductImages
Isolated FunctionRemote Function
function receiveACountOfAllProductImages(string productId, map<string|string[]> headers, *ReceiveACountOfAllProductImagesQueries queries) returns BlogsCount|errorReceive a count of all Product Images
Parameters
- productId string - The ID of the product
- queries *ReceiveACountOfAllProductImagesQueries - Queries to be sent with the request
Return Type
- BlogsCount|error - Get a count all product images / Get a count of all product images after a specified ID / Get a count all product images / Get a count of all product images after a specified ID
retrieveAListOfProductVariants
Isolated FunctionRemote Function
function retrieveAListOfProductVariants(string productId, map<string|string[]> headers, *RetrieveAListOfProductVariantsQueries queries) returns ProductVariants|errorRetrieves a list of product variants
Parameters
- productId string - The ID of the product
- queries *RetrieveAListOfProductVariantsQueries - Queries to be sent with the request
Return Type
- ProductVariants|error - Retrieve all variants for a product / Retrieve all variants for a product with prices in specified presentment currencies / Retrieve all variants for a product after a specified ID / Retrieve all variants for a product / Retrieve all variants for a product with prices in specified presentment currencies / Retrieve all variants for a product after a specified ID
createANewProductVariant
Isolated FunctionRemote Function
function createANewProductVariant(string productId, CreateProductVariant payload, map<string|string[]> headers) returns CreateProductVariant|errorCreate a new Product Variant
Parameters
- productId string - The ID of the product
- payload CreateProductVariant - Product variant details
Return Type
- CreateProductVariant|error - Create a new product variant with an image / Create a new product variant with a metafield / Create a new product variant / Create a new product variant with an image / Create a new product variant with a metafield / Create a new product variant
receiveACountOfAllProductVariants
Isolated FunctionRemote Function
function receiveACountOfAllProductVariants(string productId, map<string|string[]> headers) returns ArticlesCount|errorReceive a count of all Product Variants
Parameters
- productId string - The ID of the product
Return Type
- ArticlesCount|error - Retrieve a count all variants for a product / Retrieve a count all variants for a product
receiveASingleProductVariant
Isolated FunctionRemote Function
function receiveASingleProductVariant(string variantId, map<string|string[]> headers, *ReceiveASingleProductVariantQueries queries) returns ProductVariantResponse|errorReceive a single Product Variant
Parameters
- variantId string - The ID of the product variant
- queries *ReceiveASingleProductVariantQueries - Queries to be sent with the request
Return Type
- ProductVariantResponse|error - Retrieve a product variant by ID / Retrieve a product variant by ID
modifyAnExistingProductVariant
Isolated FunctionRemote Function
function modifyAnExistingProductVariant(string variantId, UpdateProductVariant payload, map<string|string[]> headers) returns ModifyProductVariant|errorModify an existing Product Variant
Parameters
- variantId string - The ID of the product variant
- payload UpdateProductVariant - Updated product variant details
Return Type
- ModifyProductVariant|error - Add a metafield to an existing variant / Add an existing image to an existing variant / Update the title and price of an existing variant / Add a metafield to an existing variant / Add an existing image to an existing variant / Update the title and price of an existing variant
removeAnExistingProductVariant
Isolated FunctionRemote Function
function removeAnExistingProductVariant(string productId, string variantId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing Product Variant
Parameters
- productId string - The ID of the product
- variantId string - The ID of the product variant
- payload string - Request body for removing a product variant
Return Type
- record {}|error - Delete a product variant / Delete a product variant
retrieveAListOfSmartCollections
Isolated FunctionRemote Function
function retrieveAListOfSmartCollections(map<string|string[]> headers, *RetrieveAListOfSmartCollectionsQueries queries) returns SmartCollectionList|errorRetrieves a list of smart collections
Parameters
- queries *RetrieveAListOfSmartCollectionsQueries - Queries to be sent with the request
Return Type
- SmartCollectionList|error - Retrieve a list of all smart collections for a certain product_id / Retrieve a list of specific smart collections / Retrieve a list of all smart collections / Retrieve a list all smart collections after a specified ID / Retrieve a list of all smart collections for a certain product_id / Retrieve a list of specific smart collections / Retrieve a list of all smart collections / Retrieve a list all smart collections after a specified ID
createASmartCollection
Isolated FunctionRemote Function
function createASmartCollection(ApiVersionSmartCollectionsJsonBody payload, map<string|string[]> headers) returns CreatSmartCollection|errorCreates a smart collection
Parameters
- payload ApiVersionSmartCollectionsJsonBody - Smart collection details
Return Type
- CreatSmartCollection|error - Create a new smart collection with a base64 encoded image / Create a smart collection of all products starting with the specified term / Create a smart collection with a specified title / Create a new smart collection with an image that will be downloaded by Shopify / Create a new unpublished smart collection / Create a new smart collection with a base64 encoded image / Create a smart collection of all products starting with the specified term / Create a smart collection with a specified title / Create a new smart collection with an image that will be downloaded by Shopify / Create a new unpublished smart collection
retrieveASingleSmartCollection
Isolated FunctionRemote Function
function retrieveASingleSmartCollection(string smartCollectionId, map<string|string[]> headers, *RetrieveASingleSmartCollectionQueries queries) returns SmartCollectionResponse|errorRetrieves a single smart collection
Parameters
- smartCollectionId string - The ID of the smart collection
- queries *RetrieveASingleSmartCollectionQueries - Queries to be sent with the request
Return Type
- SmartCollectionResponse|error - Retrieve a specific collection by ID / Retrieve a specific collection by ID
updateAnExistingSmartCollection
Isolated FunctionRemote Function
function updateAnExistingSmartCollection(string smartCollectionId, SmartCollectionssmartCollectionIdJsonBody payload, map<string|string[]> headers) returns UpdateSmartCollection|errorUpdates an existing smart collection
Parameters
- smartCollectionId string - The ID of the smart collection
- payload SmartCollectionssmartCollectionIdJsonBody - Updated smart collection details
Return Type
- UpdateSmartCollection|error - Update the description of a smart collection / Hide a published smart collection / Update a smart collection by setting a new collection image alternative text / Update a smart collection by clearing the collection image / Publish a hidden collection / Update a smart collection by setting a new collection image / Update the description of a smart collection / Hide a published smart collection / Update a smart collection by setting a new collection image alternative text / Update a smart collection by clearing the collection image / Publish a hidden collection / Update a smart collection by setting a new collection image
removeASmartCollection
Isolated FunctionRemote Function
function removeASmartCollection(string smartCollectionId, string payload, map<string|string[]> headers) returns record {}|errorRemoves a smart collection
Parameters
- smartCollectionId string - The ID of the smart collection
- payload string - Request body for removing a smart collection
Return Type
- record {}|error - Remove a smart collection / Remove a smart collection
retrieveACountOfSmartCollections
Isolated FunctionRemote Function
function retrieveACountOfSmartCollections(map<string|string[]> headers, *RetrieveACountOfSmartCollectionsQueries queries) returns ObjectCount|errorRetrieves a count of smart collections
Parameters
- queries *RetrieveACountOfSmartCollectionsQueries - Queries to be sent with the request
Return Type
- ObjectCount|error - Retrieve a count of all smart collections for a certain product_id / Retrieve a count of all smart collections / Retrieve a count of all smart collections for a certain product_id / Retrieve a count of all smart collections
updateTheOrderingTypeOfProductsInASmartCollection
Isolated FunctionRemote Function
function updateTheOrderingTypeOfProductsInASmartCollection(string smartCollectionId, record {} payload, map<string|string[]> headers) returns record {}|errorUpdates the ordering type of products in a smart collection
Parameters
- smartCollectionId string - The ID of the smart collection
- payload record {} - Smart collection ordering details
Return Type
- record {}|error - Update the type of ordering applied to the smart collection / Update manually-sorted products in the smart collection / Update the type of ordering applied to the smart collection / Update manually-sorted products in the smart collection
completeACheckout
Isolated FunctionRemote Function
function completeACheckout(string token, record {} payload, map<string|string[]> headers) returns CompleteCheckoutResponse|errorCompletes a checkout
Return Type
- CompleteCheckoutResponse|error - Complete a checkout without requiring payment / Complete a checkout without requiring payment
retrieveACheckout
Isolated FunctionRemote Function
function retrieveACheckout(string token, map<string|string[]> headers) returns CompleteCheckout|CheckoutResponse|errorRetrieves a checkout
Parameters
- token string - The checkout token
Return Type
- CompleteCheckout|CheckoutResponse|error - Retrieve a completed checkout / Retrieve a completed checkout
modifyAnExistingCheckout
Isolated FunctionRemote Function
function modifyAnExistingCheckout(string token, CheckoutstokenJsonBody payload, map<string|string[]> headers) returns ShippingRateResponse|UpdateCheckoutResponse|errorModifies an existing checkout
Parameters
- token string - The checkout token
- payload CheckoutstokenJsonBody - Updated checkout details
Return Type
- ShippingRateResponse|UpdateCheckoutResponse|error - Select a shipping rate / Select a shipping rate
retrieveAListOfShippingRates
Isolated FunctionRemote Function
function retrieveAListOfShippingRates(string token, map<string|string[]> headers) returns AvailableShippingRates|ShippingRates|errorRetrieves a list of shipping rates
Parameters
- token string - The checkout token
Return Type
- AvailableShippingRates|ShippingRates|error - Retrieve available shipping rates / Retrieving shipping rates when none are available for the current shipping address or cart returns an empty array / Retrieve available shipping rates / Retrieving shipping rates when none are available for the current shipping address or cart returns an empty array
retrieveCollectionListingsThatArePublishedToYourApp
Isolated FunctionRemote Function
function retrieveCollectionListingsThatArePublishedToYourApp(map<string|string[]> headers, *RetrieveCollectionListingsThatArePublishedToYourAppQueries queries) returns CollectionListingResponse|errorRetrieve collection listings that are published to your app
Parameters
- queries *RetrieveCollectionListingsThatArePublishedToYourAppQueries - Queries to be sent with the request
Return Type
- CollectionListingResponse|error - Retrieve collection listings that are published to your app / Retrieve collection listings that are published to your app
retrieveProductIdsThatArePublishedToACollectionId
Isolated FunctionRemote Function
function retrieveProductIdsThatArePublishedToACollectionId(string collectionListingId, map<string|string[]> headers, *RetrieveProductIdsThatArePublishedToACollectionIdQueries queries) returns ProductIds|errorRetrieve product_ids that are published to a collection_id
Parameters
- collectionListingId string - The ID of the product collection
- queries *RetrieveProductIdsThatArePublishedToACollectionIdQueries - Queries to be sent with the request
Return Type
- ProductIds|error - Retrieve <code>product_ids</code> that are published to a <code>collection_id</code> / Retrieve <code>product_ids</code> that are published to a <code>collection_id</code>
retrieveASpecificCollectionListingThatIsPublishedToYourApp
Isolated FunctionRemote Function
function retrieveASpecificCollectionListingThatIsPublishedToYourApp(string collectionListingId, map<string|string[]> headers) returns CollectionListing|errorRetrieve a specific collection listing that is published to your app
Parameters
- collectionListingId string - The ID of the product collection
Return Type
- CollectionListing|error - Retrieve a specific collection listing that is published to your app / Retrieve a specific collection listing that is published to your app
createACollectionListingToPublishACollectionToYourApp
Isolated FunctionRemote Function
function createACollectionListingToPublishACollectionToYourApp(string collectionListingId, CollectionListingscollectionListingIdJsonBody payload, map<string|string[]> headers) returns CollectionListing|errorCreate a collection listing to publish a collection to your app
Parameters
- collectionListingId string - The ID of the product collection
- payload CollectionListingscollectionListingIdJsonBody - Collection listing details
Return Type
- CollectionListing|error - Create a collection listing to publish a collection to your app / Create a collection listing to publish a collection to your app
deleteACollectionListingToUnpublishACollectionFromYourApp
Isolated FunctionRemote Function
function deleteACollectionListingToUnpublishACollectionFromYourApp(string collectionListingId, string payload, map<string|string[]> headers) returns string|errorDelete a collection listing to unpublish a collection from your app
Parameters
- collectionListingId string - The ID of the product collection
- payload string - Request body for deleting a collection listing
Return Type
retrieveAListOfPaymentsOnAParticularCheckout
Isolated FunctionRemote Function
function retrieveAListOfPaymentsOnAParticularCheckout(string token, map<string|string[]> headers) returns PaymentsResponse|errorRetrieves a list of payments on a particular checkout
Parameters
- token string - The checkout token
Return Type
- PaymentsResponse|error - Retrieve all the payments on a checkout
createANewPayment
Isolated FunctionRemote Function
function createANewPayment(string token, TokenPaymentsJsonBody payload, map<string|string[]> headers) returns CreateAuthorizationResponse|errorCreates a new payment
Return Type
- CreateAuthorizationResponse|error - Create an authorization using a valid <code>session_id</code> stored in the vault / Create an authorization using a valid <code>session_id</code> stored in the vault
retrieveASinglePayment
Isolated FunctionRemote Function
function retrieveASinglePayment(string token, string paymentId, map<string|string[]> headers) returns SinglePaymentResponse|errorRetrieves a single payment
Return Type
- SinglePaymentResponse|error - Retrieve a payment with a succesful transaction / Retrieve a payment with a failed transaction / Retrieve a payment with a succesful transaction / Retrieve a payment with a failed transaction
receiveAListOfAllProductResourceFeedbacks
Isolated FunctionRemote Function
function receiveAListOfAllProductResourceFeedbacks(string productId, map<string|string[]> headers) returns ResourceFeedbackList|errorReceive a list of all Product ResourceFeedbacks
Parameters
- productId string - The ID of the product
Return Type
- ResourceFeedbackList|error - Receive a list of all Product ResourceFeedbacks
createANewProductResourceFeedback
Isolated FunctionRemote Function
function createANewProductResourceFeedback(string productId, ProductIdResourceFeedbackJsonBody payload, map<string|string[]> headers) returns ResourceFeedbackList|errorCreate a new Product ResourceFeedback
Parameters
- productId string - The ID of the product
- payload ProductIdResourceFeedbackJsonBody - Product resource feedback details
Return Type
- ResourceFeedbackList|error - Create a new Product ResourceFeedback
retrieveProductListingsThatArePublishedToYourApp
Isolated FunctionRemote Function
function retrieveProductListingsThatArePublishedToYourApp(map<string|string[]> headers, *RetrieveProductListingsThatArePublishedToYourAppQueries queries) returns ProductListings|errorRetrieve product listings that are published to your app
Parameters
- queries *RetrieveProductListingsThatArePublishedToYourAppQueries - Queries to be sent with the request
Return Type
- ProductListings|error - Retrieve product listings that are published to your app / Retrieve product listings that are published to your app
retrieveASpecificProductListingThatIsPublishedToYourApp
Isolated FunctionRemote Function
function retrieveASpecificProductListingThatIsPublishedToYourApp(string productListingId, map<string|string[]> headers) returns ProductListingAppResponse|errorRetrieve a specific product listing that is published to your app
Parameters
- productListingId string - The ID of the product listing
Return Type
- ProductListingAppResponse|error - Retrieve a specific product listing that is published to your app / Retrieve a specific product listing that is published to your app
createAProductListingToPublishAProductToYourApp
Isolated FunctionRemote Function
function createAProductListingToPublishAProductToYourApp(string productListingId, ProductListingsproductListingIdJsonBody payload, map<string|string[]> headers) returns ProductListingAppResponse|errorCreate a product listing to publish a product to your app
Parameters
- productListingId string - The ID of the product listing
- payload ProductListingsproductListingIdJsonBody - Product listing details
Return Type
- ProductListingAppResponse|error - Create a product listing to publish a product to your app / Create a product listing to publish a product to your app
deleteAProductListingToUnpublishAProductFromYourApp
Isolated FunctionRemote Function
function deleteAProductListingToUnpublishAProductFromYourApp(string productListingId, string payload, map<string|string[]> headers) returns string|errorDelete a product listing to unpublish a product from your app
Parameters
- productListingId string - The ID of the product listing
- payload string - Request body for deleting a product listing
Return Type
retrieveACountOfProductsThatArePublishedToYourApp
Isolated FunctionRemote Function
function retrieveACountOfProductsThatArePublishedToYourApp(map<string|string[]> headers) returns BlogsCount|errorRetrieve a count of products that are published to your app
Return Type
- BlogsCount|error - Retrieve a count of products that are published to your app / Retrieve a count of products that are published to your app
retrieveProductIdsThatArePublishedToYourApp
Isolated FunctionRemote Function
function retrieveProductIdsThatArePublishedToYourApp(map<string|string[]> headers, *RetrieveProductIdsThatArePublishedToYourAppQueries queries) returns ProductIdAppResponse|errorRetrieve product_ids that are published to your app
Parameters
- queries *RetrieveProductIdsThatArePublishedToYourAppQueries - Queries to be sent with the request
Return Type
- ProductIdAppResponse|error - Retrieve <code>product_ids</code> that are published to your app / Retrieve <code>product_ids</code> that are published to your app
receiveAListOfAllResourceFeedbacks
Isolated FunctionRemote Function
function receiveAListOfAllResourceFeedbacks(map<string|string[]> headers) returns ResourceFeedbackList|errorReceive a list of all ResourceFeedbacks
Return Type
- ResourceFeedbackList|error - Get a list of resource feedback records for a specific shop / Get a list of resource feedback records for a specific shop
createANewResourceFeedback
Isolated FunctionRemote Function
function createANewResourceFeedback(ApiVersionResourceFeedbackJsonBody payload, map<string|string[]> headers) returns CreateShopFeedback|errorCreate a new ResourceFeedback
Parameters
- payload ApiVersionResourceFeedbackJsonBody - Resource feedback details
Return Type
- CreateShopFeedback|error - Create a shop feedback record indicating the Shop is usable by your app / Create a shop feedback record indicating a problem specific to your app / Create a shop feedback record indicating the Shop is usable by your app / Create a shop feedback record indicating a problem specific to your app
retrievesAListOfFulfillmentOrdersAssignedToTheShopLocationsThatAreOwnedByTheApp
Isolated FunctionRemote Function
function retrievesAListOfFulfillmentOrdersAssignedToTheShopLocationsThatAreOwnedByTheApp(map<string|string[]> headers, *RetrievesAListOfFulfillmentOrdersAssignedToTheShopLocationsThatAreOwnedByTheAppQueries queries) returns FulfillmentOrders|errorRetrieves a list of fulfillment orders assigned to the shop locations that are owned by the app
Parameters
- queries *RetrievesAListOfFulfillmentOrdersAssignedToTheShopLocationsThatAreOwnedByTheAppQueries - Queries to be sent with the request
Return Type
- FulfillmentOrders|error - Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app / Retrieve a list of fulfillment orders in cancellation_requested state at a location for an app
sendACancellationRequest
Isolated FunctionRemote Function
function sendACancellationRequest(string fulfillmentOrderId, FulfillmentOrderIdCancellationRequestJsonBody payload, map<string|string[]> headers) returns FulfillmentOrder|errorSends a cancellation request
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdCancellationRequestJsonBody - Cancellation request details
Return Type
- FulfillmentOrder|error - Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order / Sends a cancellation request to the fulfillment service of a fulfillment order and updates the fulfillment order
acceptACancellationRequest
Isolated FunctionRemote Function
function acceptACancellationRequest(string fulfillmentOrderId, CancellationRequestAcceptJsonBody payload, map<string|string[]> headers) returns CancellationResponse|errorAccepts a cancellation request
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload CancellationRequestAcceptJsonBody - Cancellation acceptance details
Return Type
- CancellationResponse|error - Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order / Accepts a cancellation request sent to a fulfillment service and updates the fulfillment order
rejectACancellationRequest
Isolated FunctionRemote Function
function rejectACancellationRequest(string fulfillmentOrderId, CancellationRequestRejectJsonBody payload, map<string|string[]> headers) returns RejectCancellationRequestResponse|errorRejects a cancellation request
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload CancellationRequestRejectJsonBody - Cancellation rejection details
Return Type
- RejectCancellationRequestResponse|error - Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order / Rejects a cancellation request sent to a fulfillment service and updates the fulfillment order
retrieveAListOfCarrierServices
Isolated FunctionRemote Function
function retrieveAListOfCarrierServices(map<string|string[]> headers) returns CarrierServiceList|errorRetrieves a list of carrier services
Return Type
- CarrierServiceList|error - Retrieve a list of carrier services / Retrieve a list of carrier services
createACarrierService
Isolated FunctionRemote Function
function createACarrierService(ApiVersionCarrierServicesJsonBody payload, map<string|string[]> headers) returns CreateCarrierService|errorCreates a carrier service
Parameters
- payload ApiVersionCarrierServicesJsonBody - Carrier service details
Return Type
- CreateCarrierService|error - Create a carrier service / Create a carrier service
retrieveASingleCarrierService
Isolated FunctionRemote Function
function retrieveASingleCarrierService(string carrierServiceId, map<string|string[]> headers) returns SingleCarrierService|errorRetrieves a single carrier service
Parameters
- carrierServiceId string - The ID of the carrier service
Return Type
- SingleCarrierService|error - Retrieve a single carrier service / Retrieve a single carrier service
modifyAnExistingCarrierservice
Isolated FunctionRemote Function
function modifyAnExistingCarrierservice(string carrierServiceId, CarrierServicescarrierServiceIdJsonBody payload, map<string|string[]> headers) returns UpdateCarrierService|errorModify an existing CarrierService
Parameters
- carrierServiceId string - The ID of the carrier service
- payload CarrierServicescarrierServiceIdJsonBody - Updated carrier service details
Return Type
- UpdateCarrierService|error - Update a carrier service / Update a carrier service
deleteACarrierService
Isolated FunctionRemote Function
function deleteACarrierService(string carrierServiceId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a carrier service
Parameters
- carrierServiceId string - The ID of the carrier service
- payload string - Request body for deleting a carrier service
Return Type
- record {}|error - Delete a carrier service / Delete a carrier service
createAFulfillmentForOneOrManyFulfillmentOrders
Isolated FunctionRemote Function
function createAFulfillmentForOneOrManyFulfillmentOrders(CreateOrderFulfillment payload, map<string|string[]> headers) returns CreateFulfillmentOrder|errorCreates a fulfillment for one or many fulfillment orders
Parameters
- payload CreateOrderFulfillment - Fulfillment details
Return Type
- CreateFulfillmentOrder|error - Create a fulfillment for the fulfillment order line items specified / Creates a fulfillment for all fulfillment order line items if
fulfillment_order_line_itemsis left blank / Create a fulfillment for the fulfillment order line items specified / Creates a fulfillment for all fulfillment order line items iffulfillment_order_line_itemsis left blank
cancelAFulfillment
Isolated FunctionRemote Function
function cancelAFulfillment(string fulfillmentId, record {} payload, map<string|string[]> headers) returns CancelFulfillment|errorCancels a fulfillment
Parameters
- fulfillmentId string - The ID of the fulfillment
- payload record {} - Fulfillment cancellation request details
Return Type
- CancelFulfillment|error - Cancel a fulfillment / Cancel a fulfillment
updateTheTrackingInformationForAFulfillment
Isolated FunctionRemote Function
function updateTheTrackingInformationForAFulfillment(string fulfillmentId, FulfillmentIdUpdateTrackingJsonBody payload, map<string|string[]> headers) returns Fulfillment|errorUpdates the tracking information for a fulfillment
Parameters
- fulfillmentId string - The ID of the fulfillment
- payload FulfillmentIdUpdateTrackingJsonBody - Updated tracking information details
Return Type
- Fulfillment|error - Update the tracking information for a fulfillment / Update the tracking information for a fulfillment
retrieveFulfillmentsAssociatedWithAFulfillmentOrder
Isolated FunctionRemote Function
function retrieveFulfillmentsAssociatedWithAFulfillmentOrder(string fulfillmentOrderId, map<string|string[]> headers) returns FulfillmentList|errorRetrieves fulfillments associated with a fulfillment order
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
Return Type
- FulfillmentList|error - Retrieve a list of all fulfillments for a fulfillment order / Retrieve a list of all fulfillments for a fulfillment order
retrieveFulfillmentsAssociatedWithAnOrder
Isolated FunctionRemote Function
function retrieveFulfillmentsAssociatedWithAnOrder(string orderId, map<string|string[]> headers, *RetrieveFulfillmentsAssociatedWithAnOrderQueries queries) returns FulfillmentListForOrder|errorRetrieves fulfillments associated with an order
Parameters
- orderId string - The ID of the order
- queries *RetrieveFulfillmentsAssociatedWithAnOrderQueries - Queries to be sent with the request
Return Type
- FulfillmentListForOrder|error - Retrieve a list of all fulfillments for an order / Retrieve all fulfillments after the specified ID / Retrieve a list of all fulfillments for an order / Retrieve all fulfillments after the specified ID
receiveASingleFulfillment
Isolated FunctionRemote Function
function receiveASingleFulfillment(string orderId, string fulfillmentId, map<string|string[]> headers, *ReceiveASingleFulfillmentQueries queries) returns SingleFulfillment|errorReceive a single Fulfillment
Parameters
- orderId string - The ID of the order
- fulfillmentId string - The ID of the fulfillment
- queries *ReceiveASingleFulfillmentQueries - Queries to be sent with the request
Return Type
- SingleFulfillment|error - Retrieve a specific fulfillment / Retrieve a specific fulfillment
retrieveACountOfFulfillmentsAssociatedWithASpecificOrder
Isolated FunctionRemote Function
function retrieveACountOfFulfillmentsAssociatedWithASpecificOrder(string orderId, map<string|string[]> headers, *RetrieveACountOfFulfillmentsAssociatedWithASpecificOrderQueries queries) returns ObjectCount|errorRetrieves a count of fulfillments associated with a specific order
Parameters
- orderId string - The ID of the order
- queries *RetrieveACountOfFulfillmentsAssociatedWithASpecificOrderQueries - Queries to be sent with the request
Return Type
- ObjectCount|error - Count the total number of fulfillments for an order / Count the total number of fulfillments for an order
retrieveAListOfFulfillmentEventsForASpecificFulfillment
Isolated FunctionRemote Function
function retrieveAListOfFulfillmentEventsForASpecificFulfillment(string orderId, string fulfillmentId, map<string|string[]> headers) returns FulfillmentEvents|errorRetrieves a list of fulfillment events for a specific fulfillment
Return Type
- FulfillmentEvents|error - Retrieve a list of all the fulfillment events that are associated with a specific fulfillment / Retrieve a list of all the fulfillment events that are associated with a specific fulfillment
createAFulfillmentEvent
Isolated FunctionRemote Function
function createAFulfillmentEvent(string orderId, string fulfillmentId, FulfillmentIdEventsJsonBody payload, map<string|string[]> headers) returns CreateFulfillmentEvent|errorCreates a fulfillment event
Parameters
- orderId string - The ID of the order
- fulfillmentId string - The ID of the fulfillment
- payload FulfillmentIdEventsJsonBody - Fulfillment event details
Return Type
- CreateFulfillmentEvent|error - Create a fulfillment event / Create a fulfillment event
retrieveASpecificFulfillmentEvent
Isolated FunctionRemote Function
function retrieveASpecificFulfillmentEvent(string orderId, string fulfillmentId, string eventId, map<string|string[]> headers) returns FulfillmentEventResponse|errorRetrieves a specific fulfillment event
Parameters
- orderId string - The ID of the order
- fulfillmentId string - The ID of the fulfillment
- eventId string - The ID of the event
Return Type
- FulfillmentEventResponse|error - Retrieve a specific fulfillment event / Retrieve a specific fulfillment event
deleteAFulfillmentEvent
Isolated FunctionRemote Function
function deleteAFulfillmentEvent(string orderId, string fulfillmentId, string eventId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a fulfillment event
Parameters
- orderId string - The ID of the order
- fulfillmentId string - The ID of the fulfillment
- eventId string - The ID of the event
- payload string - Request body for deleting a fulfillment event
Return Type
- record {}|error - Delete a fulfillment event / Delete a fulfillment event
cancelAFulfillmentOrder
Isolated FunctionRemote Function
function cancelAFulfillmentOrder(string fulfillmentOrderId, FulfillmentOrderIdCancelJsonBody payload, map<string|string[]> headers) returns CancelFulfillmentOrder|errorCancel a fulfillment order
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdCancelJsonBody - Fulfillment order cancellation details
Return Type
- CancelFulfillmentOrder|error - Cancel a fulfillment order / Cancel a fulfillment order
markAFulfillmentOrderAsIncomplete
Isolated FunctionRemote Function
function markAFulfillmentOrderAsIncomplete(string fulfillmentOrderId, FulfillmentOrderIdCloseJsonBody payload, map<string|string[]> headers) returns TransitionFulfillmentOrder|errorMarks a fulfillment order as incomplete
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdCloseJsonBody - Fulfillment order close details
Return Type
- TransitionFulfillmentOrder|error - Transition a fulfillment order from in progress to incomplete / Transition a fulfillment order from in progress to incomplete
applyAFulfillmentHoldOnAnOpenFulfillmentOrder
Isolated FunctionRemote Function
function applyAFulfillmentHoldOnAnOpenFulfillmentOrder(string fulfillmentOrderId, FulfillmentOrderIdHoldJsonBody payload, map<string|string[]> headers) returns MoveFulfillmentOrderResponse|errorApplies a fulfillment hold on an open fulfillment order
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdHoldJsonBody - Fulfillment hold details
Return Type
- MoveFulfillmentOrderResponse|error - Move a fulfillment order to a new location / Move a fulfillment order to a new location
moveAFulfillmentOrderToANewLocation
Isolated FunctionRemote Function
function moveAFulfillmentOrderToANewLocation(string fulfillmentOrderId, FulfillmentOrderIdMoveJsonBody payload, map<string|string[]> headers) returns MoveFulfillmentOrderResponse|errorMoves a fulfillment order to a new location
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdMoveJsonBody - Fulfillment order move details
Return Type
- MoveFulfillmentOrderResponse|error - Move a fulfillment order to a new location / Move a fulfillment order to a new location
markTheFulfillmentOrderAsOpen
Isolated FunctionRemote Function
function markTheFulfillmentOrderAsOpen(string fulfillmentOrderId, FulfillmentOrderIdOpenJsonBody payload, map<string|string[]> headers) returns MoveFulfillmentOrderResponse|errorMarks the fulfillment order as open
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdOpenJsonBody - Fulfillment order open request details
Return Type
- MoveFulfillmentOrderResponse|error - Move a fulfillment order to a new location / Move a fulfillment order to a new location
releaseTheFulfillmentHoldOnAFulfillmentOrder
Isolated FunctionRemote Function
function releaseTheFulfillmentHoldOnAFulfillmentOrder(string fulfillmentOrderId, FulfillmentOrderIdReleaseHoldJsonBody payload, map<string|string[]> headers) returns MoveFulfillmentOrderResponse|errorReleases the fulfillment hold on a fulfillment order
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdReleaseHoldJsonBody - Fulfillment hold release details
Return Type
- MoveFulfillmentOrderResponse|error - Move a fulfillment order to a new location / Move a fulfillment order to a new location
rescheduleTheFulfillAtTimeOfAScheduledFulfillmentOrder
Isolated FunctionRemote Function
function rescheduleTheFulfillAtTimeOfAScheduledFulfillmentOrder(string fulfillmentOrderId, FulfillmentOrderIdRescheduleJsonBody payload, map<string|string[]> headers) returns MoveFulfillmentOrderResponse|errorReschedules the fulfill_at time of a scheduled fulfillment order
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdRescheduleJsonBody - Fulfillment reschedule details
Return Type
- MoveFulfillmentOrderResponse|error - Move a fulfillment order to a new location / Move a fulfillment order to a new location
setDeadlineForFulfillmentOrders
Isolated FunctionRemote Function
function setDeadlineForFulfillmentOrders(FulfillmentOrdersSetFulfillmentOrdersDeadlineJsonBody payload, map<string|string[]> headers) returns MoveFulfillmentOrderResponse|errorSets deadline for fulfillment orders
Parameters
- payload FulfillmentOrdersSetFulfillmentOrdersDeadlineJsonBody - Fulfillment orders deadline details
Return Type
- MoveFulfillmentOrderResponse|error - Move a fulfillment order to a new location / Move a fulfillment order to a new location
retrieveASpecificFulfillmentOrder
Isolated FunctionRemote Function
function retrieveASpecificFulfillmentOrder(string fulfillmentOrderId, map<string|string[]> headers) returns SingleFulfillmentOrder|errorRetrieves a specific fulfillment order
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
Return Type
- SingleFulfillmentOrder|error - Get a single fulfillment order by its ID / Get a single fulfillment order by its ID
retrieveAListOfFulfillmentOrdersForASpecificOrder
Isolated FunctionRemote Function
function retrieveAListOfFulfillmentOrdersForASpecificOrder(string orderId, map<string|string[]> headers) returns FulfillmentOrdersList|errorRetrieves a list of fulfillment orders for a specific order
Parameters
- orderId string - The ID of the order
Return Type
- FulfillmentOrdersList|error - Retrieve a list of all fulfillment orders for an order / Retrieve a list of all fulfillment orders for an order
sendAFulfillmentRequest
Isolated FunctionRemote Function
function sendAFulfillmentRequest(string fulfillmentOrderId, FulfillmentOrderIdFulfillmentRequestJsonBody payload, map<string|string[]> headers) returns OriginalFulfillmentOrder|errorSends a fulfillment request
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentOrderIdFulfillmentRequestJsonBody - Fulfillment request details
Return Type
- OriginalFulfillmentOrder|error - Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items / Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank / Sends a fulfillment request to the fulfillment service of a fulfillment order for the specified line items / Sends a fulfillment request to the fulfillment service for all line items on the fulfillment order if fulfillment_order_line_items is left blank
acceptAFulfillmentRequest
Isolated FunctionRemote Function
function acceptAFulfillmentRequest(string fulfillmentOrderId, FulfillmentRequestAcceptJsonBody payload, map<string|string[]> headers) returns AcceptFulfillmentResponse|errorAccepts a fulfillment request
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentRequestAcceptJsonBody - Fulfillment acceptance details
Return Type
- AcceptFulfillmentResponse|error - Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order / Accepts a fulfillment request sent to a fulfillment service and updates the fulfillment order
rejectAFulfillmentRequest
Isolated FunctionRemote Function
function rejectAFulfillmentRequest(string fulfillmentOrderId, FulfillmentRequestRejectJsonBody payload, map<string|string[]> headers) returns RejectFulfillmentResponse|errorRejects a fulfillment request
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
- payload FulfillmentRequestRejectJsonBody - Fulfillment rejection details
Return Type
- RejectFulfillmentResponse|error - Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order / Rejects a fulfillment request sent to a fulfillment service and updates the fulfillment order
receiveAListOfAllFulfillmentServices
Isolated FunctionRemote Function
function receiveAListOfAllFulfillmentServices(map<string|string[]> headers, *ReceiveAListOfAllFulfillmentServicesQueries queries) returns FulfillmentServicesList|errorReceive a list of all FulfillmentServices
Parameters
- queries *ReceiveAListOfAllFulfillmentServicesQueries - Queries to be sent with the request
Return Type
- FulfillmentServicesList|error - List your app's fulfillment services / List all of the shop's fulfillment services / List your app's fulfillment services / List all of the shop's fulfillment services
createANewFulfillmentService
Isolated FunctionRemote Function
function createANewFulfillmentService(ApiVersionFulfillmentServicesJsonBody payload, map<string|string[]> headers) returns CreateFulfillmentService|errorCreate a new FulfillmentService
Parameters
- payload ApiVersionFulfillmentServicesJsonBody - Fulfillment service details
Return Type
- CreateFulfillmentService|error - Create a fulfillment service / Create a fulfillment service
receiveASingleFulfillmentService
Isolated FunctionRemote Function
function receiveASingleFulfillmentService(string fulfillmentServiceId, map<string|string[]> headers) returns SingleFulfillmentService|errorReceive a single FulfillmentService
Parameters
- fulfillmentServiceId string - The ID of the fulfillment service
Return Type
- SingleFulfillmentService|error - Get a single fulfillment service by its ID / Get a single fulfillment service by its ID
modifyAnExistingFulfillmentService
Isolated FunctionRemote Function
function modifyAnExistingFulfillmentService(string fulfillmentServiceId, FulfillmentServicesfulfillmentServiceIdJsonBody payload, map<string|string[]> headers) returns UpdateFulfillmentService|errorModify an existing FulfillmentService
Parameters
- fulfillmentServiceId string - The ID of the fulfillment service
- payload FulfillmentServicesfulfillmentServiceIdJsonBody - Updated fulfillment service details
Return Type
- UpdateFulfillmentService|error - Update a fulfillment service / Update a fulfillment service
removeAnExistingFulfillmentService
Isolated FunctionRemote Function
function removeAnExistingFulfillmentService(string fulfillmentServiceId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing FulfillmentService
Parameters
- fulfillmentServiceId string - The ID of the fulfillment service
- payload string - Request body for removing a fulfillment service
Return Type
- record {}|error - Destroy a fulfillment service / Destroy a fulfillment service
retrieveAListOfLocationsThatAFulfillmentOrderCanPotentiallyMoveTo
Isolated FunctionRemote Function
function retrieveAListOfLocationsThatAFulfillmentOrderCanPotentiallyMoveTo(string fulfillmentOrderId, map<string|string[]> headers) returns LocationsList|errorRetrieves a list of locations that a fulfillment order can potentially move to.
Parameters
- fulfillmentOrderId string - The ID of the fulfillment order
Return Type
- LocationsList|error - Retrieve a list of locations that a fulfillment order can potentially move to. / Retrieve a list of locations that a fulfillment order can potentially move to
returnTheCurrentBalance
Isolated FunctionRemote Function
function returnTheCurrentBalance(map<string|string[]> headers) returns AccountCurrentBalance|errorReturn the current balance
Return Type
- AccountCurrentBalance|error - Retrieves the account's current balance. / Retrieves the account's current balance
returnAListOfAllDisputes
Isolated FunctionRemote Function
function returnAListOfAllDisputes(map<string|string[]> headers, *ReturnAListOfAllDisputesQueries queries) returns Disputes|errorReturn a list of all disputes
Parameters
- queries *ReturnAListOfAllDisputesQueries - Queries to be sent with the request
Return Type
returnASingleDispute
Isolated FunctionRemote Function
function returnASingleDispute(string disputeId, map<string|string[]> headers) returns SingleDispute|errorReturn a single dispute
Parameters
- disputeId string - The ID of the dispute
Return Type
- SingleDispute|error - Retrieves a single dispute by ID / Retrieves a single dispute by ID
returnEvidenceAssociatedWithTheDispute
Isolated FunctionRemote Function
function returnEvidenceAssociatedWithTheDispute(string disputeId, map<string|string[]> headers) returns DisputeEvidenceResponse|errorReturns evidence associated with the dispute
Parameters
- disputeId string - The ID of the dispute
Return Type
- DisputeEvidenceResponse|error - Returns evidence associated with the dispute
returnEvidenceAssociatedWithTheDisputeCopy
Isolated FunctionRemote Function
function returnEvidenceAssociatedWithTheDisputeCopy(string disputeId, DisputeIdDisputeEvidencesJsonBody payload, map<string|string[]> headers) returns DisputeEvidenceResponse|errorUpdates dispute evidence associated with the dispute ID.
Parameters
- disputeId string - The ID of the dispute
- payload DisputeIdDisputeEvidencesJsonBody - Dispute evidence details
Return Type
- DisputeEvidenceResponse|error - Updates dispute evidence associated with the dispute ID
uploadAFileToADispute
Isolated FunctionRemote Function
function uploadAFileToADispute(string disputeId, DisputeIdDisputeFileUploadsJsonBody payload, map<string|string[]> headers) returns DisputeFileUpload|errorUpload a file to a dispute
Parameters
- disputeId string - The ID of the dispute
- payload DisputeIdDisputeFileUploadsJsonBody - Dispute file upload details
Return Type
- DisputeFileUpload|error - Upload a file to a dispute
deleteADisputeEvidenceFile
Isolated FunctionRemote Function
function deleteADisputeEvidenceFile(string disputeId, string disputeFileUploadId, map<string|string[]> headers) returns error?Delete a dispute evidence file
Parameters
- disputeId string - The ID of the dispute
- disputeFileUploadId string - The ID of the dispute file upload
Return Type
- error? - Delete a dispute evidence file
returnAListOfAllPayouts
Isolated FunctionRemote Function
function returnAListOfAllPayouts(map<string|string[]> headers, *ReturnAListOfAllPayoutsQueries queries) returns PayoutsList|errorReturn a list of all payouts
Parameters
- queries *ReturnAListOfAllPayoutsQueries - Queries to be sent with the request
Return Type
- PayoutsList|error - List all payouts up to a specific date / List all payouts ordered newest to oldest / List all payouts up to a specific date / List all payouts ordered newest to oldest
returnASinglePayout
Isolated FunctionRemote Function
function returnASinglePayout(string payoutId, map<string|string[]> headers) returns SinglePayout|errorReturn a single payout
Parameters
- payoutId string - The ID of the payout
Return Type
- SinglePayout|error - Retrieves a single payout by id. / Retrieves a single payout by id
returnAListOfAllBalanceTransactions
Isolated FunctionRemote Function
function returnAListOfAllBalanceTransactions(map<string|string[]> headers, *ReturnAListOfAllBalanceTransactionsQueries queries) returns TransactionsListForPayout|errorReturn a list of all balance transactions
Parameters
- queries *ReturnAListOfAllBalanceTransactionsQueries - Queries to be sent with the request
Return Type
- TransactionsListForPayout|error - List all transactions associated with a payout. / List all transactions associated with a payout
receiveAListOfAllCountries
Isolated FunctionRemote Function
function receiveAListOfAllCountries(map<string|string[]> headers, *ReceiveAListOfAllCountriesQueries queries) returns CountriesList|errorReceive a list of all Countries
Parameters
- queries *ReceiveAListOfAllCountriesQueries - Queries to be sent with the request
Return Type
- CountriesList|error - Retrieve all countries after the specified ID / Retrieve all countries / Retrieve all countries after the specified ID / Retrieve all countries
createACountry
Isolated FunctionRemote Function
function createACountry(ApiVersionCountriesJsonBody payload, map<string|string[]> headers) returns CreateCountry|errorCreates a country
Parameters
- payload ApiVersionCountriesJsonBody - Country details
Return Type
- CreateCountry|error - Create a country using a custom tax rate / Create a country using Shopify's tax rate for it / Create a country using a custom tax rate / Create a country using Shopify's tax rate for it
retrieveASpecificCounty
Isolated FunctionRemote Function
function retrieveASpecificCounty(string countryId, map<string|string[]> headers, *RetrieveASpecificCountyQueries queries) returns CountryResponse|errorRetrieves a specific county
Parameters
- countryId string - The ID of the country
- queries *RetrieveASpecificCountyQueries - Queries to be sent with the request
Return Type
- CountryResponse|error - Retrieve a specific country by its ID / Retrieve a specific country by its ID
updateAnExistingCountry
Isolated FunctionRemote Function
function updateAnExistingCountry(string countryId, CountriescountryIdJsonBody payload, map<string|string[]> headers) returns UpdateCountryTaxRate|errorUpdates an existing country
Parameters
- countryId string - The ID of the country
- payload CountriescountryIdJsonBody - Updated country details
Return Type
- UpdateCountryTaxRate|error - Update a country's tax rate / Update a country's tax rate
removeAnExistingCountry
Isolated FunctionRemote Function
function removeAnExistingCountry(string countryId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing Country
Parameters
- countryId string - The ID of the country
- payload string - Request body for removing a country
Return Type
- record {}|error - Delete a country / Delete a country
retrieveACountOfCountries
Isolated FunctionRemote Function
function retrieveACountOfCountries(map<string|string[]> headers) returns CountriesCount|errorRetrieves a count of countries
Return Type
- CountriesCount|error - Count all countries / Count all countries
retrieveAListOfCurrenciesEnabledOnAShop
Isolated FunctionRemote Function
function retrieveAListOfCurrenciesEnabledOnAShop(map<string|string[]> headers) returns CurrenciesList|errorRetrieves a list of currencies enabled on a shop
Return Type
- CurrenciesList|error - Retrieve a list of currencies enabled on a shop / Retrieve a list of currencies enabled on a shop
retrieveAListOfTheShopSPolicies
Isolated FunctionRemote Function
function retrieveAListOfTheShopSPolicies(map<string|string[]> headers) returns ShopPoliciesList|errorRetrieves a list of the shop's policies
Return Type
- ShopPoliciesList|error - Retrieve a list of the shop's policies / Retrieve a list of the shop's policies
retrieveAListOfProvincesForACountry
Isolated FunctionRemote Function
function retrieveAListOfProvincesForACountry(string countryId, map<string|string[]> headers, *RetrieveAListOfProvincesForACountryQueries queries) returns ProvincesList|errorRetrieves a list of provinces for a country
Parameters
- countryId string - The ID of the country
- queries *RetrieveAListOfProvincesForACountryQueries - Queries to be sent with the request
Return Type
- ProvincesList|error - Retrieve all provinces for a country / Retrieve all provinces for a country after the specified ID / Retrieve all provinces for a country / Retrieve all provinces for a country after the specified ID
retrieveASingleProvinceForACountry
Isolated FunctionRemote Function
function retrieveASingleProvinceForACountry(string countryId, string provinceId, map<string|string[]> headers, *RetrieveASingleProvinceForACountryQueries queries) returns SingleProvince|errorRetrieves a single province for a country
Parameters
- countryId string - The ID of the country
- provinceId string - The ID of the province
- queries *RetrieveASingleProvinceForACountryQueries - Queries to be sent with the request
Return Type
- SingleProvince|error - Retrieve a single province / Retrieve a single province
updateAnExistingProvinceForACountry
Isolated FunctionRemote Function
function updateAnExistingProvinceForACountry(string countryId, string provinceId, ProvincesprovinceIdJsonBody payload, map<string|string[]> headers) returns UpdateProvinceResponse|errorUpdates an existing province for a country
Parameters
- countryId string - The ID of the country
- provinceId string - The ID of the province
- payload ProvincesprovinceIdJsonBody - Updated province details
Return Type
- UpdateProvinceResponse|error - Update a province's tax rate / Update a province's tax rate
retrieveACountOfProvincesForACountry
Isolated FunctionRemote Function
function retrieveACountOfProvincesForACountry(string countryId, map<string|string[]> headers) returns ProvincesCount|errorRetrieves a count of provinces for a country
Parameters
- countryId string - The ID of the country
Return Type
- ProvincesCount|error - Count all provinces / Count all provinces
receiveAListOfAllShippingzones
Isolated FunctionRemote Function
function receiveAListOfAllShippingzones(map<string|string[]> headers, *ReceiveAListOfAllShippingzonesQueries queries) returns ShippingZonesList|errorReceive a list of all ShippingZones
Parameters
- queries *ReceiveAListOfAllShippingzonesQueries - Queries to be sent with the request
Return Type
- ShippingZonesList|error - Retrieve all shipping zones
retrieveTheShopSConfiguration
Isolated FunctionRemote Function
function retrieveTheShopSConfiguration(map<string|string[]> headers, *RetrieveTheShopSConfigurationQueries queries) returns ShopConfigurations|errorRetrieves the shop's configuration
Parameters
- queries *RetrieveTheShopSConfigurationQueries - Queries to be sent with the request
Return Type
- ShopConfigurations|error - Retrieve the shop's configuration / Retrieve the shop's configuration
retrieveAListOfTenderTransactions
Isolated FunctionRemote Function
function retrieveAListOfTenderTransactions(map<string|string[]> headers, *RetrieveAListOfTenderTransactionsQueries queries) returns TenderTransactions|errorRetrieves a list of tender transactions
Parameters
- queries *RetrieveAListOfTenderTransactionsQueries - Queries to be sent with the request
Return Type
- TenderTransactions|error - Retrieve tender transactions processed_at the specified date / Retrieve tender transactions after the specified ID / Retrieve tender transactions ordered by <code>processed_at</code> / Retrieve tender transactions processed_at or after the specified date / Retrieve all tender transactions / Retrieve tender transactions processed_at or before the specified date / Retrieve tender transactions processed_at the specified date / Retrieve tender transactions after the specified ID / Retrieve tender transactions ordered by <code>processed_at</code> / Retrieve tender transactions processed_at or after the specified date / Retrieve all tender transactions / Retrieve tender transactions processed_at or before the specified date
retrieveAListOfWebhooks
Isolated FunctionRemote Function
function retrieveAListOfWebhooks(map<string|string[]> headers, *RetrieveAListOfWebhooksQueries queries) returns SubscriptionsList|errorRetrieves a list of webhooks
Parameters
- queries *RetrieveAListOfWebhooksQueries - Queries to be sent with the request
Return Type
- SubscriptionsList|error - Retrieve a list of all webhook subscriptions for your shop / Retrieve a list of all webhook subscriptions for your shop after a specified <code>id</code> / Retrieve a list of all webhook subscriptions for your shop / Retrieve a list of all webhook subscriptions for your shop after a specified <code>id</code>
createANewWebhook
Isolated FunctionRemote Function
function createANewWebhook(CreateWebhook payload, map<string|string[]> headers) returns SubscribeOrderCreation|errorCreate a new Webhook
Parameters
- payload CreateWebhook - Webhook details
Return Type
- SubscribeOrderCreation|error - Subscribe to order creation webhooks / Subscribe to order creation webhooks
receiveASingleWebhook
Isolated FunctionRemote Function
function receiveASingleWebhook(string webhookId, map<string|string[]> headers, *ReceiveASingleWebhookQueries queries) returns SingleWebhook|errorReceive a single Webhook
Parameters
- webhookId string - The ID of the webhook
- queries *ReceiveASingleWebhookQueries - Queries to be sent with the request
Return Type
- SingleWebhook|error - Retrieve a single webhook by its <code>id</code> / Retrieve a single webhook by its <code>id</code>
modifyAnExistingWebhook
Isolated FunctionRemote Function
function modifyAnExistingWebhook(string webhookId, UpdateWebhook payload, map<string|string[]> headers) returns WebhookObject|errorModify an existing Webhook
Return Type
- WebhookObject|error - Update a webhook subscription so that it POSTs to a different address / Update a webhook subscription so that it POSTs to a different address
removeAnExistingWebhook
Isolated FunctionRemote Function
function removeAnExistingWebhook(string webhookId, string payload, map<string|string[]> headers) returns record {}|errorRemove an existing Webhook
Parameters
- webhookId string - The ID of the webhook
- payload string - Request body for removing a webhook
Return Type
- record {}|error - Delete an existing webhook from a shop / Delete an existing webhook from a shop
receiveACountOfAllWebhooks
Isolated FunctionRemote Function
function receiveACountOfAllWebhooks(map<string|string[]> headers, *ReceiveACountOfAllWebhooksQueries queries) returns ObjectCount|errorReceive a count of all Webhooks
Parameters
- queries *ReceiveACountOfAllWebhooksQueries - Queries to be sent with the request
Return Type
- ObjectCount|error - Count all of the webhook subscriptions for the topic <code>orders/create</code> / Count all of the webhook subscriptions for your shop / Count all of the webhook subscriptions for the topic <code>orders/create</code> / Count all of the webhook subscriptions for your shop
retrieveAListOfReports
Isolated FunctionRemote Function
function retrieveAListOfReports(map<string|string[]> headers, *RetrieveAListOfReportsQueries queries) returns ReportList|errorRetrieves a list of reports
Parameters
- queries *RetrieveAListOfReportsQueries - Queries to be sent with the request
Return Type
- ReportList|error - Retrieves a list of reports
createANewReport
Isolated FunctionRemote Function
function createANewReport(ApiVersionReportsJsonBody payload, map<string|string[]> headers) returns ReportResponse|errorCreates a new report
Parameters
- payload ApiVersionReportsJsonBody - Report details
Return Type
- ReportResponse|error - Creates a new report
retrieveASingleReport
Isolated FunctionRemote Function
function retrieveASingleReport(string reportId, map<string|string[]> headers, *RetrieveASingleReportQueries queries) returns SingleReportResponse|errorRetrieves a single report
Parameters
- reportId string - The ID of the report
- queries *RetrieveASingleReportQueries - Queries to be sent with the request
Return Type
- SingleReportResponse|error - Retrieves a single report
updateAReport
Isolated FunctionRemote Function
function updateAReport(string reportId, ReportsreportIdJsonBody payload, map<string|string[]> headers) returns UpdateReportResponse|errorUpdates a report
Parameters
- reportId string - The ID of the report
- payload ReportsreportIdJsonBody - Updated report details
Return Type
- UpdateReportResponse|error - Updates a report
deleteAReport
Isolated FunctionRemote Function
function deleteAReport(string reportId, string payload, map<string|string[]> headers) returns record {}|errorDeletes a report
Return Type
- record {}|error - Deletes a report
countTheNumberOfPaymentsAttemptedOnACheckout
Isolated FunctionRemote Function
function countTheNumberOfPaymentsAttemptedOnACheckout(string token, map<string|string[]> headers) returns ObjectCount|errorCounts the number of payments attempted on a checkout
Parameters
- token string - The checkout token
Return Type
- ObjectCount|error - Retrieve the number of payments on a checkout
Records
shopify.admin: AbandonedCheckouts
Fields
- checkouts? AbandonedCheckoutsCheckouts[] -
shopify.admin: AbandonedCheckoutsCheckouts
Fields
- note? anydata? -
- createdAt? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? AbandonedCheckoutsLineItems[] -
- 'source? anydata? -
- taxesIncluded? boolean -
- buyerAcceptsMarketing? boolean -
- presentmentCurrency? string -
- locationId? anydata? -
- sourceUrl? anydata? -
- totalWeight? int -
- landingSite? anydata? -
- sourceIdentifier? anydata? -
- totalDiscounts? string -
- referringSite? anydata? -
- taxLines? AbandonedCheckoutsTaxLines[] -
- updatedAt? string -
- customerLocale? anydata? -
- currency? string -
- abandonedCheckoutUrl? string -
- id? int -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- email? string -
- sourceName? string -
- subtotalPrice? string -
- closedAt? anydata? -
- deviceId? anydata? -
- totalPrice? string -
- totalLineItemsPrice? string -
- totalTax? string -
- token? string -
- completedAt? string? -
- shippingLines? AbandonedCheckoutsShippingLines[] -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? ReopenCloseOrderOrderNoteAttributes[] -
- name? string -
- cartToken? string -
- discountCodes? anydata[] -
- gateway? string? -
- customer? AbandonedCheckoutsCustomer -
shopify.admin: AbandonedCheckoutsCustomer
Fields
- totalSpent? string -
- note? anydata? -
- lastOrderName? string -
- lastOrderId? int -
- taxExempt? boolean -
- createdAt? string -
- lastName? string -
- multipassIdentifier? anydata? -
- verifiedEmail? boolean -
- acceptsMarketingUpdatedAt? string -
- ordersCount? int -
- defaultAddress? ReopenCloseOrderOrderCustomerDefaultAddress -
- updatedAt? string -
- acceptsMarketing? boolean -
- phone? anydata? -
- adminGraphqlApiId? string -
- taxExemptions? anydata[] -
- currency? string -
- id? int -
- marketingOptInLevel? anydata? -
- state? string -
- firstName? string -
- email? string -
shopify.admin: AbandonedCheckoutsLineItems
Fields
- variantTitle? string? -
- giftCard? boolean -
- requiresShipping? boolean -
- title? string -
- originLocationId? anydata? -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? string -
- productId? int? -
- grams? int -
- sku? string? -
- 'key? int -
- linePrice? string -
- unitPriceMeasurement? anydata? -
- compareAtPrice? anydata? -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- variantPrice? anydata? -
- countryHsCodes? anydata[] -
- userId? anydata? -
- destinationLocationId? anydata? -
- provinceCodeOfOrigin? anydata? -
- countryCodeOfOrigin? anydata? -
- harmonizedSystemCode? anydata? -
- appliedDiscounts? anydata[] -
- properties? anydata? -
shopify.admin: AbandonedCheckoutsShippingLines
Fields
- code? string -
- price? string -
- id? string -
- 'source? string -
- title? string -
- appliedDiscounts? anydata[] -
shopify.admin: AbandonedCheckoutsTaxLines
Fields
- rate? decimal -
- price? string -
- title? string -
shopify.admin: AcceptFulfillmentResponse
Fields
- fulfillmentOrder? AcceptFulfillmentResponseFulfillmentOrder -
shopify.admin: AcceptFulfillmentResponseFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? AcceptFulfillmentResponseFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? AcceptFulfillmentResponseFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: AcceptFulfillmentResponseFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: AcceptFulfillmentResponseFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: AccessScopes
Fields
- accessScopes? AccessScopesAccessScopes[] -
shopify.admin: AccessScopesAccessScopes
Fields
- 'handle? string -
shopify.admin: AccountActivationUrl
Fields
- accountActivationUrl? string -
shopify.admin: AccountCurrentBalance
Fields
- balance? AccountCurrentBalanceBalance[] -
shopify.admin: AccountCurrentBalanceBalance
Fields
- amount? string -
- currency? string -
shopify.admin: AccountInvite
Fields
- customerInvite? AccountInviteCustomerInvite -
shopify.admin: AccountInviteCustomerInvite
Fields
- customMessage? string -
- bcc? string[] -
- subject? string -
- 'from? string -
- to? string -
shopify.admin: Address
Fields
- zip? string? -
- country? string? -
- address2? string? -
- city? string? -
- address1? string? -
- lastName? string? -
- provinceCode? string? -
- countryCode? string? -
- default? boolean -
- province? string? -
- phone? string? -
- name? string? -
- countryName? string? -
- company? string? -
- id? int -
- customerId? int -
- firstName? string? -
shopify.admin: AddressesaddressIdJsonBody
Fields
shopify.admin: AddressList
Fields
- addresses? ReopenCloseOrderOrderCustomerDefaultAddress[] -
shopify.admin: AdminapiapiVersionapplicationChargesJsonApplicationCharge
Fields
- name? string -
shopify.admin: AdminapiapiVersionblogsblogIdarticlesarticleIdJsonArticle
Fields
- metafields? AdminapiapiVersioncustomerscustomerIdJsonCustomerMetafields[] -
- id? int -
shopify.admin: AdminapiapiVersionblogsblogIdarticlesJsonArticle
Fields
- bodyHtml? string -
- published? boolean -
- title? string -
shopify.admin: AdminapiapiVersionblogsblogIdJsonBlog
Fields
- id? int -
- title? string -
shopify.admin: AdminapiapiVersionblogsJsonBlog
Fields
- metafields? AdminapiapiVersionblogsJsonBlogMetafields[] -
- title? string -
shopify.admin: AdminapiapiVersionblogsJsonBlogMetafields
Fields
- valueType? string -
- namespace? string -
- value? string -
- 'key? string -
shopify.admin: AdminapiapiVersioncarrierServicescarrierServiceIdJsonCarrierService
Fields
- name? string -
- active? boolean -
- id? int -
shopify.admin: AdminapiapiVersioncarrierServicesJsonCarrierService
Fields
- callbackUrl? string -
- name? string -
- serviceDiscovery? boolean -
shopify.admin: AdminapiapiVersioncheckoutsJsonCheckout
Fields
- email? string -
shopify.admin: AdminapiapiVersioncheckoutstokenJsonCheckout
Fields
- shippingAddress? AdminapiapiVersioncheckoutstokenJsonCheckoutShippingAddress -
- token? string -
shopify.admin: AdminapiapiVersioncheckoutstokenJsonCheckoutShippingAddress
Fields
- zip? string -
- countryCode? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- firstName? string -
shopify.admin: AdminapiapiVersioncheckoutstokenpaymentsJsonPayment
Fields
- uniqueToken? string -
- amount? string -
- sessionId? string -
- requestDetails? AdminapiapiVersioncheckoutstokenpaymentsJsonPaymentRequestDetails -
shopify.admin: AdminapiapiVersioncheckoutstokenpaymentsJsonPaymentRequestDetails
Fields
- acceptLanguage? string -
- ipAddress? string -
- userAgent? string -
shopify.admin: AdminapiapiVersioncollectionListingscollectionListingIdJsonCollectionListing
Fields
- collectionId? int -
shopify.admin: AdminapiapiVersioncollectsJsonCollect
Fields
- collectionId? int -
- productId? int? -
shopify.admin: AdminapiapiVersioncommentscommentIdJsonComment
Fields
- id? int -
- body? string -
- publishedAt? string -
- email? string -
shopify.admin: AdminapiapiVersioncommentsJsonComment
Fields
- articleId? int -
shopify.admin: AdminapiapiVersioncountriescountryIdJsonCountry
Fields
- tax? decimal -
- id? int -
shopify.admin: AdminapiapiVersioncountriescountryIdprovincesprovinceIdJsonProvince
Fields
- tax? decimal -
- id? int -
shopify.admin: AdminapiapiVersioncountriesJsonCountry
Fields
- code? string -
shopify.admin: AdminapiapiVersioncustomCollectionscustomCollectionIdJsonCustomCollection
Fields
- id? int -
- published? boolean -
shopify.admin: AdminapiapiVersioncustomCollectionsJsonCustomCollection
Fields
- title? string -
shopify.admin: AdminapiapiVersioncustomCollectionsJsonCustomCollectionImage
Fields
- src? string -
- alt? string -
shopify.admin: AdminapiapiVersioncustomerscustomerIdaddressesaddressIdJsonAddress
Fields
- zip? string -
- id? int -
shopify.admin: AdminapiapiVersioncustomerscustomerIdaddressesJsonAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? string -
- firstName? string -
shopify.admin: AdminapiapiVersioncustomerscustomerIdJsonCustomerMetafields
Fields
- namespace? string -
- 'type? string -
- value? string -
- 'key? string -
shopify.admin: AdminapiapiVersiondraftOrdersdraftOrderIdJsonDraftOrder
Fields
- note? string? -
- id? int -
shopify.admin: AdminapiapiVersiondraftOrdersJsonDraftOrder
Fields
- lineItems? AdminapiapiVersiondraftOrdersJsonDraftOrderLineItems[] -
shopify.admin: AdminapiapiVersiondraftOrdersJsonDraftOrderAppliedDiscount
Fields
- amount? string -
- valueType? string -
- description? string -
- title? string -
- value? string -
shopify.admin: AdminapiapiVersiondraftOrdersJsonDraftOrderLineItems
Fields
- quantity? int -
- appliedDiscount? AdminapiapiVersiondraftOrdersJsonDraftOrderAppliedDiscount -
- price? string -
- title? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancelJsonFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- assignedLocationId? int -
- id? int -
- orderId? int -
- supportedActions? string[] -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancelJsonFulfillmentOrderAssignedLocation
Fields
- zip? anydata? -
- countryCode? string -
- province? anydata? -
- address2? anydata? -
- city? anydata? -
- phone? anydata? -
- address1? anydata? -
- name? string -
- locationId? int -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancelJsonFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancelJsonFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancellationRequestacceptJsonCancellationRequest
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancellationRequestJsonCancellationRequest
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancellationRequestrejectJsonCancellationRequest
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcloseJsonFulfillmentOrder
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdfulfillmentRequestacceptJsonFulfillmentRequest
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdfulfillmentRequestJsonFulfillmentRequest
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdfulfillmentRequestrejectJsonFulfillmentRequest
Fields
- message? string -
shopify.admin: AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder
Fields
- newLocationId? int -
shopify.admin: AdminapiapiVersionfulfillmentServicesfulfillmentServiceIdJsonFulfillmentService
Fields
- name? string -
- id? int -
shopify.admin: AdminapiapiVersionfulfillmentServicesJsonFulfillmentService
Fields
- callbackUrl? string -
- inventoryManagement? boolean -
- requiresShippingMethod? boolean -
- format? string -
- name? string -
- trackingSupport? boolean -
shopify.admin: AdminapiapiVersionfulfillmentsfulfillmentIdupdateTrackingJsonFulfillment
Fields
- notifyCustomer? boolean -
shopify.admin: AdminapiapiVersionfulfillmentsfulfillmentIdupdateTrackingJsonFulfillmentTrackingInfo
Fields
- number? string -
- company? string -
- url? string -
shopify.admin: AdminapiapiVersiongiftCardsgiftCardIddisableJsonGiftCard
Fields
- id? int -
shopify.admin: AdminapiapiVersiongiftCardsgiftCardIdJsonGiftCard
Fields
- note? string? -
- id? int -
shopify.admin: AdminapiapiVersiongiftCardsJsonGiftCard
Fields
- initialValue? string -
- sendOn? string -
- message? string -
- recipientId? int -
shopify.admin: AdminapiapiVersioninventoryItemsinventoryItemIdJsonInventoryItem
Fields
- cost? string -
- id? int -
shopify.admin: AdminapiapiVersionmarketingEventsJsonMarketingEvent
Fields
- eventType? string -
- utmCampaign? string -
- utmMedium? string -
- paid? boolean -
- startedAt? string -
- marketingChannel? string -
- referringDomain? string -
- utmSource? string -
shopify.admin: AdminapiapiVersionmarketingEventsmarketingEventIdengagementsJsonEngagements
Fields
- isCumulative? boolean -
- adSpend? decimal -
- occurredOn? string -
- favoritesCount? int -
- clicksCount? int -
- viewsCount? int -
shopify.admin: AdminapiapiVersionmarketingEventsmarketingEventIdJsonMarketingEvent
Fields
- utmCampaign? string -
- remoteId? string -
- utmMedium? string -
- eventType? string -
- startedAt? string -
- currency? string -
- id? int -
- scheduledToEndAt? string -
- budgetType? string -
- endedAt? string -
- budget? string -
- referringDomain? string -
- utmSource? string -
shopify.admin: AdminapiapiVersionmetafieldsJsonMetafield
Fields
- namespace? string -
- 'type? string -
- value? string -
- 'key? string -
shopify.admin: AdminapiapiVersionmobilePlatformApplicationsJsonMobilePlatformApplication
Fields
- sha256CertFingerprints? string[] -
- enabledUniversalOrAppLinks? boolean -
- applicationId? string -
- platform? string -
shopify.admin: AdminapiapiVersionmobilePlatformApplicationsmobilePlatformApplicationIdJsonMobilePlatformApplication
Fields
- updatedAt? string -
- createdAt? string -
- sha256CertFingerprints? string[] -
- enabledAppClips? boolean -
- enabledUniversalOrAppLinks? boolean -
- id? int -
- appClipApplicationId? anydata? -
- applicationId? string -
- platform? string -
shopify.admin: AdminapiapiVersionordersorderIdfulfillmentsfulfillmentIdeventsJsonEvent
Fields
- status? string -
shopify.admin: AdminapiapiVersionordersorderIdrefundscalculateJsonRefund
Fields
- refundLineItems? AdminapiapiVersionordersorderIdrefundscalculateJsonRefundRefundLineItems[] -
shopify.admin: AdminapiapiVersionordersorderIdrefundscalculateJsonRefundRefundLineItems
Fields
- lineItemId? int -
- quantity? int -
- restockType? string -
shopify.admin: AdminapiapiVersionordersorderIdrefundscalculateJsonRefundShipping
Fields
- fullRefund? boolean -
shopify.admin: AdminapiapiVersionownerIdownerResourcemetafieldsJsonMetafield
Fields
- namespace? string -
- 'type? string -
- value? string -
- 'key? string -
shopify.admin: AdminapiapiVersionpagesJsonPage
Fields
- bodyHtml? string -
- published? boolean -
- title? string -
shopify.admin: AdminapiapiVersionpagespageIdJsonPage
Fields
- id? int -
- published? boolean -
shopify.admin: AdminapiapiVersionpriceRulesJsonPriceRule
Fields
- allocationMethod? string -
- customerSelection? string -
- startsAt? string -
- valueType? string -
- targetType? string -
- targetSelection? string -
- title? string -
- value? string -
shopify.admin: AdminapiapiVersionpriceRulespriceRuleIdbatchJsonDiscountCodes
Fields
- code? string -
shopify.admin: AdminapiapiVersionpriceRulespriceRuleIddiscountCodesdiscountCodeIdJsonDiscountCode
Fields
- usageCount? int -
- code? string -
- updatedAt? string -
- createdAt? string -
- id? int -
shopify.admin: AdminapiapiVersionpriceRulespriceRuleIddiscountCodesJsonDiscountCode
Fields
- code? string -
shopify.admin: AdminapiapiVersionpriceRulespriceRuleIdJsonPriceRule
Fields
- id? int -
- title? string -
shopify.admin: AdminapiapiVersionproductListingsproductListingIdJsonProductListing
Fields
- productId? int? -
shopify.admin: AdminapiapiVersionproductsproductIdimagesimageIdJsonImage
Fields
- variantIds? decimal[] -
- id? int -
shopify.admin: AdminapiapiVersionproductsproductIdimagesJsonImage
Fields
- metafields? AdminapiapiVersionblogsJsonBlogMetafields[] -
- filename? string -
- attachment? string -
- position? int -
shopify.admin: AdminapiapiVersionproductsproductIdresourceFeedbackJsonResourceFeedback
Fields
- resourceUpdatedAt? string -
- feedbackGeneratedAt? string -
- messages? string[] -
- state? string -
shopify.admin: AdminapiapiVersionrecurringApplicationChargesrecurringApplicationChargeIdusageChargesJsonUsageCharge
Fields
- description? string -
shopify.admin: AdminapiapiVersionredirectsJsonRedirect
Fields
- body? string -
shopify.admin: AdminapiapiVersionredirectsredirectIdJsonRedirect
Fields
- path? string -
- id? int -
- target? string -
shopify.admin: AdminapiapiVersionreportsJsonReport
Fields
- name? string -
- shopifyQl? string -
shopify.admin: AdminapiapiVersionreportsreportIdJsonReport
Fields
- name? string -
- id? int -
- shopifyQl? string -
shopify.admin: AdminapiapiVersionresourceFeedbackJsonResourceFeedback
Fields
- feedbackGeneratedAt? string -
- state? string -
shopify.admin: AdminapiapiVersionscriptTagsscriptTagIdJsonScriptTag
Fields
- src? string -
- id? int -
shopify.admin: AdminapiapiVersionshopifyPaymentsdisputesdisputeIddisputeEvidencesJsonDisputeEvidence
Fields
- submitEvidence? boolean -
shopify.admin: AdminapiapiVersionshopifyPaymentsdisputesdisputeIddisputeFileUploadsJsonDisputeFileUpload
Fields
- filename? string -
- data? string -
- mimetype? string -
- documentType? string -
shopify.admin: AdminapiapiVersionsmartCollectionsJsonSmartCollection
Fields
- published? boolean -
- title? string -
shopify.admin: AdminapiapiVersionsmartCollectionsJsonSmartCollectionRules
Fields
- condition? string -
- column? string -
- relation? string -
shopify.admin: AdminapiapiVersionsmartCollectionssmartCollectionIdJsonSmartCollection
Fields
- id? int -
shopify.admin: AdminapiapiVersionsmartCollectionssmartCollectionIdJsonSmartCollectionImage
Fields
- attachment? string -
- alt? string -
shopify.admin: AdminapiapiVersionstorefrontAccessTokensJsonStorefrontAccessToken
Fields
- title? string -
shopify.admin: AdminapiapiVersionthemesthemeIdassetsJsonAsset
Fields
- 'key? string -
- sourceKey? string -
shopify.admin: AdminapiapiVersionthemesthemeIdJsonTheme
Fields
- name? string -
- id? int -
shopify.admin: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xShopifyAccessToken string - The Shopify access token used to authenticate API requests.
shopify.admin: ApiVersionApplicationChargesJsonBody
Fields
- applicationCharge? AdminapiapiVersionapplicationChargesJsonApplicationCharge -
shopify.admin: ApiVersionBlogsJsonBody
Fields
- blog? AdminapiapiVersionblogsJsonBlog -
shopify.admin: ApiVersionCarrierServicesJsonBody
Fields
- carrierService? AdminapiapiVersioncarrierServicesJsonCarrierService -
shopify.admin: ApiVersionCheckoutsJsonBody
Fields
- checkout? AdminapiapiVersioncheckoutsJsonCheckout -
shopify.admin: ApiVersionCollectsJsonBody
Fields
- collect? AdminapiapiVersioncollectsJsonCollect -
shopify.admin: ApiVersionCommentsJsonBody
Fields
- comment? AdminapiapiVersioncommentsJsonComment -
shopify.admin: ApiVersionCountriesJsonBody
Fields
- country? AdminapiapiVersioncountriesJsonCountry -
shopify.admin: ApiVersionCustomCollectionsJsonBody
Fields
- customCollection? AdminapiapiVersioncustomCollectionsJsonCustomCollection -
shopify.admin: ApiVersionDraftOrdersJsonBody
Fields
- draftOrder? AdminapiapiVersiondraftOrdersJsonDraftOrder -
shopify.admin: ApiVersionFulfillmentServicesJsonBody
Fields
- fulfillmentService? AdminapiapiVersionfulfillmentServicesJsonFulfillmentService -
shopify.admin: ApiVersionGiftCardsJsonBody
Fields
- giftCard? AdminapiapiVersiongiftCardsJsonGiftCard -
shopify.admin: ApiVersionMarketingEventsJsonBody
Fields
- marketingEvent? AdminapiapiVersionmarketingEventsJsonMarketingEvent -
shopify.admin: ApiVersionMetafieldsJsonBody
Fields
- metafield? AdminapiapiVersionmetafieldsJsonMetafield -
shopify.admin: ApiVersionMobilePlatformApplicationsJsonBody
Fields
- mobilePlatformApplication? AdminapiapiVersionmobilePlatformApplicationsJsonMobilePlatformApplication -
shopify.admin: ApiVersionPagesJsonBody
Fields
- page? AdminapiapiVersionpagesJsonPage -
shopify.admin: ApiVersionPriceRulesJsonBody
Fields
- priceRule? AdminapiapiVersionpriceRulesJsonPriceRule -
shopify.admin: ApiVersionRecurringApplicationChargesJsonBody
Fields
- recurringApplicationCharge? AdminapiapiVersionapplicationChargesJsonApplicationCharge -
shopify.admin: ApiVersionRedirectsJsonBody
Fields
- redirect? AdminapiapiVersionredirectsJsonRedirect -
shopify.admin: ApiVersionReportsJsonBody
Fields
- report? AdminapiapiVersionreportsJsonReport -
shopify.admin: ApiVersionResourceFeedbackJsonBody
Fields
- resourceFeedback? AdminapiapiVersionresourceFeedbackJsonResourceFeedback -
shopify.admin: ApiVersionScriptTagsJsonBody
Fields
- scriptTag? AdminapiapiVersionredirectsJsonRedirect -
shopify.admin: ApiVersionSmartCollectionsJsonBody
Fields
- smartCollection? AdminapiapiVersionsmartCollectionsJsonSmartCollection -
shopify.admin: ApiVersionStorefrontAccessTokensJsonBody
Fields
- storefrontAccessToken? AdminapiapiVersionstorefrontAccessTokensJsonStorefrontAccessToken -
shopify.admin: ApiVersionThemesJsonBody
Fields
shopify.admin: ApplicationCharge
Fields
- applicationCharge? ApplicationChargeApplicationCharge -
shopify.admin: ApplicationChargeApplicationCharge
Fields
- chargeType? anydata? -
- apiClientId? int -
- test? boolean? -
- createdAt? string -
- decoratedReturnUrl? string -
- updatedAt? string -
- confirmationUrl? string -
- price? string -
- name? string -
- returnUrl? string -
- currency? string -
- id? int -
- status? string -
shopify.admin: ApplicationChargeResponse
Fields
- recurringApplicationCharge? ApplicationChargeResponseRecurringApplicationCharge -
shopify.admin: ApplicationChargeResponseRecurringApplicationCharge
Fields
- apiClientId? int -
- test? boolean? -
- balanceUsed? decimal -
- balanceRemaining? decimal -
- createdAt? string -
- cancelledOn? anydata? -
- trialDays? int -
- decoratedReturnUrl? string -
- cappedAmount? string -
- riskLevel? decimal -
- updatedAt? string -
- confirmationUrl? string -
- price? string -
- trialEndsOn? anydata? -
- name? string -
- returnUrl? string -
- billingOn? anydata? -
- currency? string -
- id? int -
- activatedOn? anydata? -
- status? string -
shopify.admin: ApplicationChargeResult
Fields
- applicationCharge? ApplicationChargeResultApplicationCharge -
shopify.admin: ApplicationChargeResultApplicationCharge
Fields
- chargeType? anydata? -
- apiClientId? int -
- test? anydata? -
- updatedAt? string -
- price? string -
- name? string -
- createdAt? string -
- returnUrl? string -
- currency? string -
- id? int -
- decoratedReturnUrl? string -
- status? string -
shopify.admin: ApplicationChargesList
Fields
- applicationCharges? ApplicationChargesListApplicationCharges[] -
shopify.admin: ApplicationChargesListApplicationCharges
Fields
- chargeType? string? -
- apiClientId? int -
- test? anydata? -
- createdAt? string -
- externalId? anydata? -
- decoratedReturnUrl? string -
- updatedAt? string -
- price? string -
- name? string -
- returnUrl? string -
- currency? string -
- id? int -
- status? string -
shopify.admin: ApplicationCredit
Fields
- applicationCredit? ApplicationCreditApplicationCredit -
shopify.admin: ApplicationCreditApplicationCredit
Fields
- amount? string -
- test? anydata? -
- description? string -
- currency? string -
- id? int -
shopify.admin: ApplicationCredits
Fields
- applicationCredits? ApplicationCreditApplicationCredit[] -
shopify.admin: ApproveCommentResponse
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? string -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: Article
Fields
- article? ArticleArticle -
shopify.admin: ArticleArticle
Fields
- image? ArticleArticleImage -
- blogId? int -
- bodyHtml? string -
- createdAt? string -
- 'handle? string -
- title? string -
- templateSuffix? anydata? -
- updatedAt? string -
- userId? anydata? -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string? -
- summaryHtml? anydata? -
shopify.admin: ArticleArticleImage
Fields
- src? string -
- alt? string? -
- width? int -
- createdAt? string -
- height? int -
shopify.admin: ArticleAuthors
Fields
shopify.admin: ArticleComment
Fields
- comment? ArticleCommentComment -
shopify.admin: ArticleCommentComment
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? anydata? -
- email? string -
- userAgent? anydata? -
- status? string -
shopify.admin: ArticleComments
Fields
- comments? ArticleCommentsComments[] -
shopify.admin: ArticleCommentsComments
Fields
- blogId? int -
- bodyHtml? string? -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? anydata? -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: Articles
Fields
- articles? ArticlesArticles[] -
shopify.admin: ArticlesarticleIdJsonBody
Fields
shopify.admin: ArticlesArticles
Fields
- blogId? int -
- bodyHtml? string? -
- createdAt? string -
- 'handle? string -
- title? string -
- templateSuffix? anydata? -
- updatedAt? string -
- userId? anydata? -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? anydata? -
- summaryHtml? anydata? -
shopify.admin: ArticlesCount
Fields
- count? int -
shopify.admin: AssetsList
Fields
- assets? AssetsListAssets[] -
- asset? AssetsListAsset -
shopify.admin: AssetsListAsset
Fields
- publicUrl? string? -
- attachment? string -
- contentType? string -
- size? int -
- updatedAt? string -
- themeId? int -
- createdAt? string -
- value? string -
- 'key? string -
shopify.admin: AssetsListAssets
Fields
- publicUrl? string? -
- contentType? string -
- size? int -
- updatedAt? string -
- themeId? int -
- createdAt? string -
- 'key? string -
shopify.admin: AvailableInventory
Fields
- inventoryLevel? AvailableInventoryInventoryLevel -
shopify.admin: AvailableInventoryInventoryLevel
Fields
- updatedAt? string -
- inventoryItemId? int -
- adminGraphqlApiId? string -
- available? int -
- locationId? int -
shopify.admin: AvailableShippingRates
Fields
- shippingRates? AvailableShippingRatesShippingRates[] -
shopify.admin: AvailableShippingRatesCheckout
Fields
- subtotalPrice? string -
- totalPrice? string -
- totalTax? string -
shopify.admin: AvailableShippingRatesShippingRates
Fields
- price? string -
- deliveryRange? anydata? -
- 'handle? string -
- id? string -
- title? string -
- checkout? AvailableShippingRatesCheckout -
- phoneRequired? boolean -
shopify.admin: BlogIdArticlesJsonBody
Fields
shopify.admin: Blogs
Fields
- blogs? BlogsBlogs[] -
shopify.admin: BlogsblogIdJsonBody
Fields
shopify.admin: BlogsBlogs
Fields
- feedburner? anydata? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- feedburnerLocation? anydata? -
- createdAt? string -
- 'handle? string -
- id? int -
- title? string -
- commentable? string -
shopify.admin: BlogsCount
Fields
- count? int -
shopify.admin: CalculateRefund
Fields
- refund? CalculateRefundRefund -
shopify.admin: CalculateRefundRefund
Fields
- refundLineItems? CalculateRefundRefundRefundLineItems[] -
- shipping? CalculateRefundRefundShipping -
- currency? string -
- transactions? CalculateRefundRefundTransactions[] -
shopify.admin: CalculateRefundRefundRefundLineItems
Fields
- lineItemId? int -
- quantity? int -
- price? string -
- subtotal? string -
- discountedTotalPrice? string -
- totalCartDiscountAmount? string -
- totalTax? string -
- locationId? anydata? -
- discountedPrice? string -
- restockType? string -
shopify.admin: CalculateRefundRefundShipping
Fields
- amount? string -
- maximumRefundable? string -
- tax? string -
shopify.admin: CalculateRefundRefundTransactions
Fields
- amount? string -
- maximumRefundable? string -
- kind? string -
- parentId? int -
- currency? string -
- orderId? int -
- gateway? string -
shopify.admin: CancelFulfillment
Fields
- fulfillment? CancelFulfillmentFulfillment -
shopify.admin: CancelFulfillmentFulfillment
Fields
- createdAt? string -
- lineItems? CancelFulfillmentFulfillmentLineItems[] -
- trackingCompany? string -
- trackingUrls? string[] -
- locationId? int -
- updatedAt? string -
- 'service? string -
- adminGraphqlApiId? string -
- name? string -
- trackingNumber? string -
- receipt? record {} -
- id? int -
- trackingNumbers? string[] -
- orderId? int -
- trackingUrl? string -
- shipmentStatus? anydata? -
- status? string -
shopify.admin: CancelFulfillmentFulfillmentLineItems
Fields
- variantTitle? string? -
- fulfillmentStatus? anydata? -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? anydata? -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderTotalDiscountsSet -
- properties? anydata[] -
shopify.admin: CancelFulfillmentOrder
Fields
- fulfillmentOrder? CancelFulfillmentOrderFulfillmentOrder -
- replacementFulfillmentOrder? CancelFulfillmentOrderReplacementFulfillmentOrder -
shopify.admin: CancelFulfillmentOrderFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? CancelFulfillmentOrderFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? CancelFulfillmentOrderFulfillmentOrderLineItems[] -
- orderId? int -
- supportedActions? anydata[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: CancelFulfillmentOrderFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: CancelFulfillmentOrderFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: CancelFulfillmentOrderReplacementFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? CancelFulfillmentOrderReplacementFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? CancelFulfillmentOrderReplacementFulfillmentOrderLineItems[] -
- orderId? int -
- supportedActions? string[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: CancelFulfillmentOrderReplacementFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: CancelFulfillmentOrderReplacementFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: CancellationRequestAcceptJsonBody
Fields
shopify.admin: CancellationRequestRejectJsonBody
Fields
shopify.admin: CancellationResponse
Fields
- fulfillmentOrder? CancellationResponseFulfillmentOrder -
shopify.admin: CancellationResponseFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? CancellationResponseFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? CancellationResponseFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: CancellationResponseFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: CancellationResponseFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: CappedAmountCharge
Fields
- recurringApplicationCharge? CappedAmountChargeRecurringApplicationCharge -
shopify.admin: CappedAmountChargeRecurringApplicationCharge
Fields
- updateCappedAmountUrl? string -
- apiClientId? int -
- test? anydata? -
- balanceUsed? decimal -
- balanceRemaining? decimal -
- createdAt? string -
- cancelledOn? anydata? -
- trialDays? int -
- decoratedReturnUrl? string -
- cappedAmount? string -
- riskLevel? decimal -
- updatedAt? string -
- price? string -
- trialEndsOn? string -
- name? string -
- returnUrl? string -
- billingOn? anydata? -
- currency? string -
- id? int -
- activatedOn? string -
- status? string -
shopify.admin: CarrierServiceList
Fields
- carrierServices? CarrierServiceListCarrierServices[] -
shopify.admin: CarrierServiceListCarrierServices
Fields
- callbackUrl? string -
- carrierServiceType? string -
- adminGraphqlApiId? string -
- format? string -
- name? string -
- serviceDiscovery? boolean -
- active? boolean -
- id? int -
shopify.admin: CarrierServicescarrierServiceIdJsonBody
Fields
- carrierService? AdminapiapiVersioncarrierServicescarrierServiceIdJsonCarrierService -
shopify.admin: CheckoutCount
Fields
- count? int -
shopify.admin: CheckoutResponse
Fields
- checkout? CheckoutResponseCheckout -
shopify.admin: CheckoutResponseCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? SinglePaymentResponsePaymentCheckoutTaxLines[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? CheckoutResponseCheckoutShippingRate -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? CheckoutResponseCheckoutShippingLine? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? anydata[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? record {}? -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: CheckoutResponseCheckoutShippingLine
Fields
- price? string -
- 'handle? string -
- title? string -
shopify.admin: CheckoutResponseCheckoutShippingRate
Fields
- price? string -
- id? string -
- title? string -
shopify.admin: CheckoutstokenJsonBody
Fields
- checkout? AdminapiapiVersioncheckoutstokenJsonCheckout -
shopify.admin: CloseOrderResponse
Fields
- 'order? CloseOrderResponseOrder -
shopify.admin: CloseOrderResponseOrder
Fields
- cancelledAt? anydata? -
- fulfillmentStatus? anydata? -
- totalPriceUsd? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ReopenCloseOrderOrderLineItems[] -
- presentmentCurrency? string -
- totalDiscountsSet? ReopenCloseOrderOrderTotalDiscountsSet -
- locationId? anydata? -
- sourceUrl? anydata? -
- landingSite? string -
- sourceIdentifier? string -
- reference? string -
- number? int -
- checkoutId? int -
- checkoutToken? string -
- taxLines? ReopenCloseOrderOrderTaxLines1[] -
- customerLocale? anydata? -
- id? int -
- appId? anydata? -
- subtotalPrice? string -
- closedAt? string -
- orderStatusUrl? string -
- deviceId? anydata? -
- test? boolean -
- totalShippingPriceSet? ReopenCloseOrderOrderTotalDiscountSet -
- subtotalPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- paymentGatewayNames? string[] -
- totalTax? string -
- processingMethod? string -
- shippingLines? ReopenCloseOrderOrderShippingLines[] -
- phone? string -
- userId? anydata? -
- noteAttributes? ReopenCloseOrderOrderNoteAttributes[] -
- name? string -
- cartToken? string -
- totalTaxSet? ReopenCloseOrderOrderPriceSet2 -
- landingSiteRef? string -
- discountCodes? ReopenCloseOrderOrderDiscountCodes[] -
- note? anydata? -
- paymentDetails? ReopenCloseOrderOrderPaymentDetails -
- orderNumber? int -
- discountApplications? ReopenCloseOrderOrderDiscountApplications[] -
- createdAt? string -
- totalLineItemsPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- taxesIncluded? boolean -
- buyerAcceptsMarketing? boolean -
- confirmed? boolean -
- totalWeight? int -
- contactEmail? string -
- refunds? ReopenCloseOrderOrderRefunds[] -
- totalDiscounts? string -
- fulfillments? ReopenCloseOrderOrderFulfillments[] -
- clientDetails? ReopenCloseOrderOrderClientDetails -
- referringSite? string -
- updatedAt? string -
- processedAt? string -
- currency? string -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- browserIp? string -
- email? string -
- sourceName? string -
- totalPriceSet? ReopenCloseOrderOrderTotalPriceSet -
- totalPrice? string -
- totalLineItemsPrice? string -
- token? string -
- cancelReason? anydata? -
- adminGraphqlApiId? string -
- financialStatus? string -
- gateway? string -
- customer? ReopenCloseOrderOrderCustomer -
shopify.admin: CollectionList
Fields
- customCollections? CollectionListCustomCollections[] -
shopify.admin: CollectionListCustomCollections
Fields
- publishedScope? string -
- bodyHtml? string? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- 'handle? string -
- id? int -
- publishedAt? string -
- title? string -
- sortOrder? string -
shopify.admin: CollectionListing
Fields
- collectionListing? CollectionListingCollectionListing -
shopify.admin: CollectionListingCollectionListing
Fields
- collectionId? int -
- bodyHtml? string -
- updatedAt? string -
- 'handle? string -
- defaultProductImage? anydata? -
- publishedAt? string -
- title? string -
- sortOrder? string -
shopify.admin: CollectionListingCollectionListingImage
Fields
- src? string -
- createdAt? string -
shopify.admin: CollectionListingResponse
Fields
- collectionListings? CollectionListingResponseCollectionListings[] -
shopify.admin: CollectionListingResponseCollectionListings
Fields
- collectionId? int -
- image? CollectionListingResponseImage? -
- bodyHtml? string? -
- updatedAt? string -
- 'handle? string -
- defaultProductImage? record {}? -
- publishedAt? string -
- title? string -
- sortOrder? string -
shopify.admin: CollectionListingResponseImage
Fields
- src? string -
- createdAt? string -
shopify.admin: CollectionListingscollectionListingIdJsonBody
Fields
- collectionListing? AdminapiapiVersioncollectionListingscollectionListingIdJsonCollectionListing -
shopify.admin: CollectResponse
Fields
- collect? CollectResponseCollect -
shopify.admin: CollectResponseCollect
Fields
- collectionId? int -
- updatedAt? anydata? -
- productId? int? -
- createdAt? anydata? -
- id? int -
- position? int -
- sortValue? string -
shopify.admin: CollectsList
Fields
- collects? CollectsListCollects[] -
shopify.admin: CollectsListCollects
Fields
- collectionId? int -
- updatedAt? anydata? -
- productId? int? -
- createdAt? anydata? -
- id? int -
- position? int -
- sortValue? string -
shopify.admin: CommentscommentIdJsonBody
Fields
shopify.admin: CompleteCheckout
Fields
- checkout? CompleteCheckoutCheckout -
shopify.admin: CompleteCheckoutCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? anydata[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? CompleteCheckoutCheckoutOrder -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? string -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? string -
- shippingRate? SinglePaymentResponsePaymentCheckoutShippingRate -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? SinglePaymentResponsePaymentCheckoutShippingLine? -
- orderId? int -
- note? string? -
- appliedDiscount? anydata? -
- payments? anydata[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? CompleteCheckoutCheckoutShippingAddress -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? anydata? -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: CompleteCheckoutCheckoutOrder
Fields
- name? string -
- id? int -
- statusUrl? string -
shopify.admin: CompleteCheckoutCheckoutShippingAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- company? anydata? -
- id? int -
- firstName? string -
shopify.admin: CompleteCheckoutResponse
Fields
- checkout? CompleteCheckoutResponseCheckout -
shopify.admin: CompleteCheckoutResponseCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? CompleteCheckoutResponseCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? anydata[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? anydata? -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? anydata? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? anydata[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? anydata? -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: CompleteCheckoutResponseCheckoutLineItems
Fields
- variantTitle? string? -
- linePrice? string -
- compareAtPrice? anydata? -
- quantity? int -
- fulfillmentService? string -
- giftCard? boolean -
- taxable? boolean -
- requiresShipping? boolean -
- imageUrl? string -
- title? string -
- variantId? int? -
- price? string -
- vendor? string -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- appliedDiscounts? anydata[] -
- 'key? int -
- properties? record {} -
shopify.admin: CompleteDraftOrder
Fields
- draftOrder? CompleteDraftOrderDraftOrder -
shopify.admin: CompleteDraftOrderDraftOrder
Fields
- note? string? -
- appliedDiscount? CompleteDraftOrderDraftOrderAppliedDiscount? -
- createdAt? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ModifyDraftOrderDraftOrderLineItems[] -
- taxesIncluded? boolean -
- taxLines? anydata[] -
- updatedAt? string -
- currency? string -
- id? int -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- email? string -
- subtotalPrice? string -
- totalPrice? string -
- taxExempt? boolean -
- invoiceSentAt? anydata? -
- totalTax? string -
- completedAt? string -
- adminGraphqlApiId? string -
- noteAttributes? anydata[] -
- name? string -
- shippingLine? ModifyDraftOrderDraftOrderShippingLine? -
- orderId? int -
- invoiceUrl? string -
- customer? AbandonedCheckoutsCustomer -
- status? string -
shopify.admin: CompleteDraftOrderDraftOrderAppliedDiscount
Fields
- amount? string -
- valueType? string -
- description? string -
- title? anydata? -
- value? string -
shopify.admin: ConnectInventoryItem
Fields
- inventoryLevel? ConnectInventoryItemInventoryLevel -
shopify.admin: ConnectInventoryItemInventoryLevel
Fields
- updatedAt? string -
- inventoryItemId? int -
- adminGraphqlApiId? string -
- available? int -
- locationId? int -
shopify.admin: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
shopify.admin: CountriesCount
Fields
- count? int -
shopify.admin: CountriescountryIdJsonBody
Fields
shopify.admin: CountriesList
Fields
- countries? CountriesListCountries[] -
shopify.admin: CountriesListCountries
Fields
- provinces? CountriesListProvinces[] -
- code? string -
- taxName? string -
- name? string -
- tax? decimal -
- id? int -
shopify.admin: CountriesListProvinces
Fields
- code? string -
- taxType? anydata? -
- taxName? anydata? -
- name? string -
- taxPercentage? decimal -
- tax? decimal -
- id? int -
- shippingZoneId? int? -
- countryId? int -
shopify.admin: Country
Fields
- provinces? record {}[] -
- code? string -
- shippingZoneId? int -
- name? string -
- tax? decimal -
- id? int -
- taxName? string -
shopify.admin: CountryResponse
Fields
- country? CountryResponseCountry -
shopify.admin: CountryResponseCountry
Fields
- provinces? CountryResponseCountryProvinces[] -
- code? string -
- taxName? string -
- name? string -
- tax? decimal -
- id? int -
shopify.admin: CountryResponseCountryProvinces
Fields
- code? string -
- taxType? string? -
- taxName? string? -
- name? string -
- taxPercentage? decimal -
- tax? decimal -
- id? int -
- shippingZoneId? anydata? -
- countryId? int -
shopify.admin: CreateAuthorizationResponse
Fields
- payment? CreateAuthorizationResponsePayment -
shopify.admin: CreateAuthorizationResponsePayment
Fields
- uniqueToken? string -
- creditCard? CreateAuthorizationResponsePaymentCheckoutCreditCard -
- paymentProcessingErrorMessage? anydata? -
- nextAction? SinglePaymentResponsePaymentNextAction -
- id? int -
- checkout? CreateAuthorizationResponsePaymentCheckout -
- 'transaction? anydata? -
- fraudulent? boolean -
shopify.admin: CreateAuthorizationResponsePaymentCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? anydata[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? SinglePaymentResponsePaymentCheckoutShippingRate -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? SinglePaymentResponsePaymentCheckoutShippingLine? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? CreateAuthorizationResponsePaymentCheckoutPayments[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? CreateAuthorizationResponsePaymentCheckoutCreditCard -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: CreateAuthorizationResponsePaymentCheckoutCreditCard
Fields
- expiryMonth? int -
- firstDigits? string -
- lastName? string -
- customerId? int -
- brand? string -
- firstName? string -
- lastDigits? string -
- expiryYear? int -
shopify.admin: CreateAuthorizationResponsePaymentCheckoutPayments
Fields
- uniqueToken? string -
- creditCard? record {}? -
- paymentProcessingErrorMessage? anydata? -
- id? int -
- 'transaction? CreateAuthorizationResponsePaymentCheckoutTransaction? -
- fraudulent? boolean -
shopify.admin: CreateAuthorizationResponsePaymentCheckoutTransaction
Fields
- amountIn? anydata? -
- amount? string -
- deviceId? anydata? -
- test? boolean -
- kind? string -
- createdAt? string -
- message? anydata? -
- locationId? anydata? -
- amountOut? anydata? -
- transactionGroupId? anydata? -
- userId? anydata? -
- parentId? anydata? -
- amountRounding? anydata? -
- currency? string -
- errorCode? anydata? -
- receipt? ReopenCloseOrderOrderReceipt -
- id? int -
- gateway? string -
- status? string -
shopify.admin: CreateBlogResponse
Fields
- blog? CreateBlogResponseBlog -
shopify.admin: CreateBlogResponseBlog
Fields
- feedburner? anydata? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- feedburnerLocation? anydata? -
- createdAt? string -
- 'handle? string -
- id? int -
- title? string -
- commentable? string -
shopify.admin: CreateCarrierService
Fields
- carrierService? CreateCarrierServiceCarrierService -
shopify.admin: CreateCarrierServiceCarrierService
Fields
- callbackUrl? string -
- carrierServiceType? string -
- adminGraphqlApiId? string -
- format? string -
- name? string -
- serviceDiscovery? boolean -
- active? boolean -
- id? int -
shopify.admin: CreateCheckoutResponse
Fields
- checkout? CreateCheckoutResponseCheckout -
shopify.admin: CreateCheckoutResponseCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? anydata? -
- lineItems? CreateCheckoutResponseCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? anydata[] -
- customerLocale? string -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? anydata? -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? record {} -
- name? string -
- shippingLine? anydata? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? anydata[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? anydata? -
- email? string? -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? anydata? -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int? -
shopify.admin: CreateCheckoutResponseCheckoutLineItems
Fields
- variantTitle? string? -
- linePrice? string -
- compareAtPrice? anydata? -
- quantity? int -
- fulfillmentService? string -
- giftCard? boolean -
- taxable? boolean -
- requiresShipping? boolean -
- imageUrl? string -
- title? string -
- variantId? int? -
- price? string -
- vendor? string -
- productId? int? -
- id? string -
- grams? int -
- sku? string? -
- appliedDiscounts? anydata[] -
- 'key? string -
- properties? record {} -
shopify.admin: CreateCollection
Fields
- customCollection? CreateCollectionCustomCollection -
shopify.admin: CreateCollectionCustomCollection
Fields
- publishedScope? string -
- bodyHtml? anydata? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- 'handle? string -
- id? int -
- publishedAt? string? -
- title? string -
- sortOrder? string -
shopify.admin: CreateCollectionCustomCollectionImage
Fields
- src? string -
- alt? string -
- width? int -
- createdAt? string -
- height? int -
shopify.admin: CreateCountry
Fields
- country? CreateCountryCountry -
shopify.admin: CreateCountryCountry
Fields
- provinces? anydata[] -
- code? string -
- taxName? string -
- name? string -
- tax? decimal -
- id? int -
shopify.admin: CreateCustomer
Fields
- customer? CreateCustomerCustomer -
shopify.admin: CreateCustomerCustomer
Fields
- note? anydata? -
- addresses? CreateCustomerCustomerAddresses[] -
- lastOrderName? anydata? -
- createdAt? string -
- multipassIdentifier? anydata? -
- acceptsMarketingUpdatedAt? string -
- defaultAddress? CreateCustomerCustomerAddresses -
- updatedAt? string -
- acceptsMarketing? boolean -
- currency? string -
- id? int -
- marketingOptInLevel? anydata? -
- state? string -
- firstName? string -
- email? string -
- totalSpent? string -
- lastOrderId? anydata? -
- taxExempt? boolean -
- emailMarketingConsent? CreateCustomerCustomerEmailMarketingConsent -
- lastName? string -
- verifiedEmail? boolean -
- ordersCount? int -
- smsMarketingConsent? CreateCustomerCustomerSmsMarketingConsent -
- phone? string -
- adminGraphqlApiId? string -
- taxExemptions? anydata[] -
shopify.admin: CreateCustomerCustomerAddresses
Fields
- zip? string -
- country? string -
- address2? anydata? -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- default? boolean -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? anydata? -
- id? int -
- customerId? int -
- firstName? string -
shopify.admin: CreateCustomerCustomerEmailMarketingConsent
Fields
- consentUpdatedAt? anydata? -
- state? string -
- optInLevel? string -
shopify.admin: CreateCustomerCustomerSmsMarketingConsent
Fields
- consentUpdatedAt? anydata? -
- consentCollectedFrom? string -
- state? string -
- optInLevel? string -
shopify.admin: CreateDiscountCode
Fields
- discountCode? CreateDiscountCodeDiscountCode -
shopify.admin: CreateDiscountCodeDiscountCode
Fields
- usageCount? int -
- code? string -
- updatedAt? string -
- priceRuleId? int -
- createdAt? string -
- id? int -
shopify.admin: CreateDraftOrder
Fields
- draftOrder? CreateDraftOrderDraftOrder -
shopify.admin: CreateDraftOrderDraftOrder
Fields
- note? anydata? -
- appliedDiscount? record {}? -
- createdAt? string -
- billingAddress? record {}? -
- lineItems? CreateDraftOrderDraftOrderLineItems[] -
- taxesIncluded? boolean -
- taxLines? CreateDraftOrderDraftOrderTaxLines[] -
- updatedAt? string -
- currency? string -
- id? int -
- shippingAddress? record {}? -
- email? string? -
- subtotalPrice? string -
- totalPrice? string -
- taxExempt? boolean -
- invoiceSentAt? anydata? -
- totalTax? string -
- completedAt? anydata? -
- adminGraphqlApiId? string -
- noteAttributes? anydata[] -
- name? string -
- shippingLine? anydata? -
- orderId? anydata? -
- invoiceUrl? string -
- customer? record {}? -
- status? string -
shopify.admin: CreateDraftOrderDraftOrderAppliedDiscount
Fields
- amount? string -
- valueType? string -
- description? string -
- title? string -
- value? string -
shopify.admin: CreateDraftOrderDraftOrderLineItems
Fields
- variantTitle? anydata? -
- quantity? int -
- appliedDiscount? CreateDraftOrderDraftOrderAppliedDiscount? -
- fulfillmentService? string -
- giftCard? boolean -
- taxable? boolean -
- requiresShipping? boolean -
- custom? boolean -
- title? string -
- variantId? anydata? -
- taxLines? CreateDraftOrderDraftOrderTaxLines[] -
- price? string -
- vendor? anydata? -
- adminGraphqlApiId? string -
- productId? anydata? -
- name? string -
- grams? int -
- sku? anydata? -
- properties? anydata[] -
shopify.admin: CreateDraftOrderDraftOrderTaxLines
Fields
- rate? decimal -
- price? string -
- title? string -
shopify.admin: CreateFulfillmentEvent
Fields
- fulfillmentEvent? CreateFulfillmentEventFulfillmentEvent -
shopify.admin: CreateFulfillmentEventFulfillmentEvent
Fields
- zip? anydata? -
- country? anydata? -
- city? anydata? -
- address1? anydata? -
- latitude? anydata? -
- happenedAt? string -
- createdAt? string -
- estimatedDeliveryAt? anydata? -
- message? anydata? -
- fulfillmentId? int -
- shopId? int -
- province? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- id? int -
- orderId? int -
- longitude? anydata? -
- status? string -
shopify.admin: CreateFulfillmentOrder
Fields
- fulfillment? CreateFulfillmentOrderFulfillment -
shopify.admin: CreateFulfillmentOrderFulfillment
Fields
- createdAt? string -
- lineItems? CreateFulfillmentOrderFulfillmentLineItems[] -
- trackingCompany? string -
- trackingUrls? string[] -
- locationId? int -
- updatedAt? string -
- 'service? string -
- adminGraphqlApiId? string -
- name? string -
- trackingNumber? string -
- receipt? record {} -
- id? int -
- trackingNumbers? string[] -
- orderId? int -
- trackingUrl? string -
- shipmentStatus? anydata? -
- status? string -
shopify.admin: CreateFulfillmentOrderFulfillmentLineItems
Fields
- variantTitle? string? -
- fulfillmentStatus? string -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? anydata? -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderTotalDiscountsSet -
- properties? anydata[] -
shopify.admin: CreateFulfillmentService
Fields
- fulfillmentService? CreateFulfillmentServiceFulfillmentService -
shopify.admin: CreateFulfillmentServiceFulfillmentService
Fields
- callbackUrl? string -
- inventoryManagement? boolean -
- serviceName? string -
- fulfillmentOrdersOptIn? boolean -
- name? string -
- providerId? anydata? -
- 'handle? string -
- id? int -
- includePendingStock? boolean -
- email? anydata? -
- locationId? int -
- trackingSupport? boolean -
shopify.admin: CreateMarketingEvent
Fields
- marketingEvent? CreateMarketingEventMarketingEvent -
shopify.admin: CreateMarketingEventMarketingEvent
Fields
- manageUrl? anydata? -
- utmCampaign? string -
- remoteId? anydata? -
- utmMedium? string -
- description? anydata? -
- eventType? string -
- previewUrl? anydata? -
- adminGraphqlApiId? string -
- paid? boolean -
- marketingActivityId? int -
- startedAt? string -
- currency? anydata? -
- id? int -
- marketingChannel? string -
- marketedResources? anydata[] -
- scheduledToEndAt? anydata? -
- budgetType? anydata? -
- endedAt? anydata? -
- budget? anydata? -
- referringDomain? string -
- utmSource? string -
shopify.admin: CreateOrder
The Order object to be created
Fields
- 'order? ReopenCloseOrderOrder -
shopify.admin: CreateOrderFulfillment
The Order fulfillment object to be created
Fields
- fulfillment? Fulfillment -
shopify.admin: CreateOrderRisk
Fields
- risk? CreateOrderRiskRisk -
shopify.admin: CreateOrderRiskRisk
Fields
- score? string -
- checkoutId? int -
- display? boolean -
- recommendation? string -
- causeCancel? boolean -
- merchantMessage? string -
- id? int -
- 'source? string -
- message? string -
- orderId? int -
shopify.admin: CreateProduct
Fields
- product? Product - The Product resource lets you update and create products in a merchant's store
shopify.admin: CreateProductImage
Fields
- image? CreateProductImageImage -
shopify.admin: CreateProductImageImage
Fields
- updatedAt? string -
- src? string -
- adminGraphqlApiId? string -
- productId? int? -
- alt? anydata? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: CreateProductResponse
Fields
- product? CreateProductResponseProduct -
shopify.admin: CreateProductResponseProduct
Fields
- image? record {}? -
- bodyHtml? string -
- images? anydata[] -
- createdAt? string -
- 'handle? string -
- variants? CreateProductResponseProductVariants[] -
- title? string -
- publishedScope? string -
- productType? string -
- templateSuffix? anydata? -
- updatedAt? string -
- vendor? string -
- adminGraphqlApiId? string -
- options? CreateProductResponseProductOptions[] -
- id? int -
- publishedAt? string? -
shopify.admin: CreateProductResponseProductOptions
Fields
- productId? int? -
- values? string[] -
- name? string -
- id? int -
- position? int -
shopify.admin: CreateProductResponseProductPresentmentPrices
Fields
- compareAtPrice? anydata? -
shopify.admin: CreateProductResponseProductVariants
Fields
- presentmentPrices? CreateProductResponseProductPresentmentPrices[] -
- inventoryManagement? anydata? -
- oldInventoryQuantity? int -
- requiresShipping? boolean -
- createdAt? string -
- title? string -
- updatedAt? string -
- inventoryItemId? int -
- price? string -
- productId? int? -
- option3? anydata? -
- option1? string -
- id? int -
- option2? string -
- grams? int -
- sku? string? -
- barcode? anydata? -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- taxable? boolean -
- weight? decimal -
- inventoryPolicy? string -
- weightUnit? string -
- adminGraphqlApiId? string -
- position? int -
- imageId? anydata? -
shopify.admin: CreateProductVariant
Fields
- variant? CreateProductVariantVariant -
shopify.admin: CreateProductVariantVariant
Fields
- presentmentPrices? CreateProductResponseProductPresentmentPrices[] -
- inventoryManagement? string -
- oldInventoryQuantity? int -
- requiresShipping? boolean -
- createdAt? string -
- title? string -
- updatedAt? string -
- inventoryItemId? int -
- price? string -
- productId? int? -
- option3? anydata? -
- option1? string -
- id? int -
- option2? anydata? -
- grams? int -
- sku? string? -
- barcode? anydata? -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- taxable? boolean -
- weight? decimal -
- inventoryPolicy? string -
- weightUnit? string -
- adminGraphqlApiId? string -
- position? int -
- imageId? int? -
shopify.admin: CreateRefund
Fields
- refund? CreateRefundRefund -
shopify.admin: CreateRefundRefund
Fields
- note? string? -
- refundLineItems? CreateRefundRefundRefundLineItems[] -
- userId? anydata? -
- adminGraphqlApiId? string -
- orderAdjustments? anydata[] -
- createdAt? string -
- processedAt? string -
- restock? boolean -
- id? int -
- transactions? CreateRefundRefundTransactions[] -
- orderId? int -
shopify.admin: CreateRefundRefundLineItem
Fields
- variantTitle? string? -
- fulfillmentStatus? anydata? -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? ReopenCloseOrderOrderTaxLines[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? string -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderPriceSet -
- properties? anydata[] -
shopify.admin: CreateRefundRefundRefundLineItems
Fields
- lineItem? CreateRefundRefundLineItem -
- lineItemId? int -
- quantity? int -
- subtotal? decimal -
- totalTaxSet? ReopenCloseOrderOrderPriceSet1 -
- id? int -
- subtotalSet? ReopenCloseOrderOrderPriceSet -
- totalTax? decimal -
- locationId? int -
- restockType? string -
shopify.admin: CreateRefundRefundTransactions
Fields
- amount? string -
- deviceId? anydata? -
- test? boolean -
- kind? string -
- createdAt? string -
- message? string -
- locationId? anydata? -
- userId? anydata? -
- parentId? int -
- adminGraphqlApiId? string -
- processedAt? string -
- currency? string -
- errorCode? anydata? -
- receipt? record {} -
- id? int -
- orderId? int -
- gateway? string -
- sourceName? string -
- status? string -
shopify.admin: CreateShopFeedback
Fields
- resourceFeedback? CreateShopFeedbackResourceFeedback -
shopify.admin: CreateShopFeedbackResourceFeedback
Fields
- resourceUpdatedAt? anydata? -
- feedbackGeneratedAt? string -
- updatedAt? string -
- resourceType? string -
- createdAt? string -
- messages? anydata[] -
- resourceId? int -
- state? string -
shopify.admin: CreateThemeResponse
Fields
- theme? CreateThemeResponseTheme -
shopify.admin: CreateThemeResponseTheme
Fields
- role? string -
- updatedAt? string -
- adminGraphqlApiId? string -
- themeStoreId? anydata? -
- name? string -
- createdAt? string -
- processing? boolean -
- id? int -
- previewable? boolean -
shopify.admin: CreateTransaction
Fields
- 'transaction? TransactionObjectTransaction -
shopify.admin: CreateWebhook
Fields
- webhook? UpdateWebhookWebhook -
shopify.admin: CreatSmartCollection
Fields
- smartCollection? CreatSmartCollectionSmartCollection -
shopify.admin: CreatSmartCollectionSmartCollection
Fields
- bodyHtml? anydata? -
- 'handle? string -
- rules? CreatSmartCollectionSmartCollectionRules[] -
- title? string -
- publishedScope? string -
- templateSuffix? anydata? -
- updatedAt? string -
- disjunctive? boolean -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string? -
- sortOrder? string -
shopify.admin: CreatSmartCollectionSmartCollectionImage
Fields
- src? string -
- alt? string -
- width? int -
- createdAt? string -
- height? int -
shopify.admin: CreatSmartCollectionSmartCollectionRules
Fields
- condition? string -
- column? string -
- relation? string -
shopify.admin: CurrenciesList
Fields
- currencies? CurrenciesListCurrencies[] -
shopify.admin: CurrenciesListCurrencies
Fields
- rateUpdatedAt? string -
- currency? string -
- enabled? boolean -
shopify.admin: CustomCollectionscustomCollectionIdJsonBody
Fields
- customCollection? AdminapiapiVersioncustomCollectionscustomCollectionIdJsonCustomCollection -
shopify.admin: Customer
Fields
- totalSpent? string -
- note? string? -
- addresses? Address[] -
- lastOrderName? string? -
- lastOrderId? int? -
- taxExempt? boolean -
- emailMarketingConsent? CustomerEmailMarketingConsent? -
- createdAt? string -
- lastName? string? -
- multipassIdentifier? string? -
- verifiedEmail? boolean -
- ordersCount? int -
- smsMarketingConsent? CustomerSmsMarketingConsent? -
- defaultAddress? Address -
- updatedAt? string -
- phone? string? -
- adminGraphqlApiId? string? -
- taxExemptions? string[] -
- currency? string? -
- id? int -
- state? string -
- firstName? string? -
- email? string? -
shopify.admin: CustomerAddress
Fields
- customerAddress? CustomerAddressCustomerAddress -
shopify.admin: CustomerAddressCustomerAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- default? boolean -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? string -
- id? int -
- customerId? int -
- firstName? string -
shopify.admin: CustomerDefaultAddress
Fields
- customerAddress? CustomerDefaultAddressCustomerAddress -
shopify.admin: CustomerDefaultAddressCustomerAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- default? boolean -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? anydata? -
- id? int -
- customerId? int -
- firstName? string -
shopify.admin: CustomerEmailMarketingConsent
Fields
- consentUpdatedAt? string -
- state? string -
- optInLevel? string -
shopify.admin: CustomerIdAddressesJsonBody
Fields
shopify.admin: CustomerIdSendInviteJsonBody
Fields
- customerInvite? record {} -
shopify.admin: CustomerInvite
Fields
- customerInvite CustomerInviteCustomerInvite -
shopify.admin: CustomerInviteCustomerInvite
Fields
- customMessage string - Custom message included in the invitation email
- bcc? string[] - Blind carbon copy recipients
- subject string - Subject of the invitation email
- 'from string - Email address of the sender
- to string - Email address of the recipient
shopify.admin: CustomerResponse
Fields
- customer? Customer -
shopify.admin: Customers
Fields
- customers? Customer[] -
shopify.admin: CustomerSmsMarketingConsent
Fields
- consentUpdatedAt? string -
- consentCollectedFrom? string -
- state? string -
- optInLevel? string -
shopify.admin: DeleteAssetResponse
Fields
- message? string -
shopify.admin: DeleteThemeResponse
Fields
- role? string -
- updatedAt? string -
- adminGraphqlApiId? string -
- themeStoreId? anydata? -
- name? string -
- createdAt? string -
- processing? boolean -
- id? int -
- previewable? boolean -
shopify.admin: DeliveryZone
Fields
- profileId? string -
- name? string -
- priceBasedShippingRates? PriceBasedShippingRate[] -
- id? int -
- countries? Country[] -
- adminGraphqlApiId? string -
- locationGroupId? string -
shopify.admin: DisableGiftCard
Fields
- giftCard? DisableGiftCardGiftCard -
shopify.admin: DisableGiftCardGiftCard
Fields
- note? anydata? -
- initialValue? string -
- lineItemId? anydata? -
- apiClientId? anydata? -
- disabledAt? string -
- expiresOn? anydata? -
- createdAt? string -
- templateSuffix? anydata? -
- balance? string -
- updatedAt? string -
- userId? anydata? -
- currency? string -
- id? int -
- customerId? anydata? -
- lastCharacters? string -
- orderId? anydata? -
shopify.admin: DiscountCode
Fields
- discountCodeCreation? DiscountCodeDiscountCodeCreation -
shopify.admin: DiscountCodeDiscountCodeCreation
Fields
- completedAt? anydata? -
- updatedAt? string -
- importedCount? int -
- priceRuleId? int -
- createdAt? string -
- startedAt? anydata? -
- failedCount? int -
- id? int -
- codesCount? int -
- status? string -
shopify.admin: DiscountCodeList
Fields
- discountCodes? DiscountCodeListDiscountCodes[] -
shopify.admin: DiscountCodeListDiscountCodes
Fields
- code? string -
- id? anydata? -
- errors? record {} -
shopify.admin: DiscountCodeResponse
Fields
- discountCodeCreation? DiscountCodeResponseDiscountCodeCreation -
shopify.admin: DiscountCodeResponseDiscountCodeCreation
Fields
- completedAt? anydata? -
- updatedAt? string -
- importedCount? int -
- priceRuleId? int -
- createdAt? string -
- startedAt? anydata? -
- failedCount? int -
- id? int -
- codesCount? int -
- status? string -
shopify.admin: DiscountCodes
Fields
- discountCodes? DiscountCodesDiscountCodes[] -
shopify.admin: DiscountCodesdiscountCodeIdJsonBody
Fields
shopify.admin: DiscountCodesDiscountCodes
Fields
- usageCount? int -
- code? string -
- updatedAt? string -
- priceRuleId? int -
- createdAt? string -
- id? int -
shopify.admin: DisputeEvidence
Fields
- refundRefusalExplanation? string? -
- customerFirstName? string -
- createdAt? string -
- disputeEvidenceFiles? DisputeEvidenceFiles -
- billingAddress? Address -
- refundPolicyDisclosure? string? -
- accessActivityLog? string? -
- uncategorizedText? string -
- fulfillments? Fulfillment[] -
- paymentsDisputeId? int -
- customerLastName? string -
- updatedAt? string -
- cancellationPolicyDisclosure? string? -
- cancellationRebuttal? string? -
- submittedByMerchantOn? string -
- id? int -
- shippingAddress? Address -
- productDescription? string -
- customerEmailAddress? string -
shopify.admin: DisputeEvidenceFiles
Fields
- customerCommunicationFileId? int -
- refundPolicyFileId? int? -
- cancellationPolicyFileId? int? -
- shippingDocumentationFileId? int -
- customerSignatureFileId? int -
- uncategorizedFileId? int -
- serviceDocumentationFileId? int? -
shopify.admin: DisputeEvidenceResponse
Fields
- disputeEvidence? DisputeEvidence -
shopify.admin: DisputeFileUpload
Fields
- shopId int -
- originalFilename string -
- filename string -
- updatedAt string -
- fileType string -
- createdAt string -
- disputeEvidenceId int -
- disputeEvidenceType string -
- id int -
- fileSize int -
- url string -
shopify.admin: DisputeIdDisputeEvidencesJsonBody
Fields
shopify.admin: DisputeIdDisputeFileUploadsJsonBody
Fields
shopify.admin: Disputes
Fields
- disputes? DisputesDisputes[] -
shopify.admin: DisputesDisputes
Fields
- reason? string -
- amount? string -
- evidenceDueBy? string -
- finalizedOn? anydata? -
- currency? string -
- id? int -
- initiatedAt? string -
- 'type? string -
- networkReasonCode? string -
- orderId? int -
- evidenceSentOn? string? -
- status? string -
shopify.admin: DraftOrderIdSendInvoiceJsonBody
Fields
- draftOrderInvoice? record {} -
shopify.admin: DraftOrders
Fields
- draftOrders? DraftOrdersDraftOrders[]? -
shopify.admin: DraftOrdersCustomer
Fields
- totalSpent? string -
- note? anydata? -
- lastOrderName? string -
- lastOrderId? int -
- taxExempt? boolean -
- createdAt? string -
- lastName? string -
- multipassIdentifier? anydata? -
- verifiedEmail? boolean -
- acceptsMarketingUpdatedAt? string -
- ordersCount? int -
- defaultAddress? ReopenCloseOrderOrderCustomerDefaultAddress -
- updatedAt? string -
- acceptsMarketing? boolean -
- phone? anydata? -
- adminGraphqlApiId? string -
- taxExemptions? anydata[] -
- currency? string -
- id? int -
- marketingOptInLevel? anydata? -
- state? string -
- firstName? string -
- email? string -
shopify.admin: DraftOrdersdraftOrderIdJsonBody
Fields
- draftOrder? AdminapiapiVersiondraftOrdersdraftOrderIdJsonDraftOrder -
shopify.admin: DraftOrdersDraftOrders
Fields
- note? string? -
- appliedDiscount? record {}? -
- createdAt? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? DraftOrdersLineItems[] -
- taxesIncluded? boolean -
- taxLines? anydata[] -
- updatedAt? string -
- currency? string -
- id? int -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- email? string -
- subtotalPrice? string -
- totalPrice? string -
- taxExempt? boolean -
- invoiceSentAt? string? -
- totalTax? string -
- completedAt? string? -
- adminGraphqlApiId? string -
- noteAttributes? anydata[] -
- name? string -
- shippingLine? record {}? -
- orderId? int? -
- invoiceUrl? string -
- customer? DraftOrdersCustomer? -
- status? string -
shopify.admin: DraftOrdersLineItems
Fields
- variantTitle? string? -
- quantity? int -
- appliedDiscount? anydata? -
- fulfillmentService? string -
- giftCard? boolean -
- taxable? boolean -
- requiresShipping? boolean -
- custom? boolean -
- title? string -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? anydata? -
- adminGraphqlApiId? string -
- productId? int? -
- name? string -
- grams? int -
- sku? string? -
- properties? anydata[] -
shopify.admin: Engagements
Fields
- engagements? EngagementsEngagements[] -
shopify.admin: EngagementsEngagements
Fields
- isCumulative? boolean -
- utcOffset? anydata? -
- adSpend? string? -
- occurredOn? string -
- favoritesCount? int? -
- uniqueViewsCount? anydata? -
- clicksCount? int -
- unsubscribesCount? anydata? -
- currencyCode? anydata? -
- fetchedAt? anydata? -
- commentsCount? anydata? -
- failsCount? anydata? -
- impressionsCount? anydata? -
- sendsCount? anydata? -
- viewsCount? int -
- complaintsCount? anydata? -
- uniqueClicksCount? anydata? -
shopify.admin: EventsCount
Fields
- count? int -
shopify.admin: EventsList
Fields
- events? anydata[] -
shopify.admin: Fulfillment
Fields
- fulfillment? FulfillmentFulfillment -
shopify.admin: FulfillmentEventResponse
Fields
- fulfillmentEvent? FulfillmentEventResponseFulfillmentEvent -
shopify.admin: FulfillmentEventResponseFulfillmentEvent
Fields
- zip? anydata? -
- country? anydata? -
- city? anydata? -
- address1? anydata? -
- latitude? anydata? -
- happenedAt? string -
- createdAt? string -
- estimatedDeliveryAt? anydata? -
- message? anydata? -
- fulfillmentId? int -
- shopId? int -
- province? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- id? int -
- orderId? int -
- longitude? anydata? -
- status? string -
shopify.admin: FulfillmentEvents
Fields
- fulfillmentEvents? FulfillmentEventsFulfillmentEvents[] -
shopify.admin: FulfillmentEventsFulfillmentEvents
Fields
- zip? anydata? -
- country? anydata? -
- city? anydata? -
- address1? anydata? -
- latitude? anydata? -
- happenedAt? string -
- createdAt? string -
- estimatedDeliveryAt? anydata? -
- message? anydata? -
- fulfillmentId? int -
- shopId? int -
- province? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- id? int -
- orderId? int -
- longitude? anydata? -
- status? string -
shopify.admin: FulfillmentFulfillment
Fields
- createdAt? string -
- lineItems? FulfillmentFulfillmentLineItems[] -
- trackingCompany? string -
- trackingUrls? string[] -
- locationId? int -
- updatedAt? string -
- 'service? string -
- adminGraphqlApiId? string -
- name? string -
- trackingNumber? string -
- receipt? record {} -
- id? int -
- trackingNumbers? string[] -
- orderId? int -
- trackingUrl? string -
- shipmentStatus? anydata? -
- status? string -
shopify.admin: FulfillmentFulfillmentLineItems
Fields
- variantTitle? string? -
- fulfillmentStatus? string -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? anydata? -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderTotalDiscountsSet -
- properties? anydata[] -
shopify.admin: FulfillmentIdEventsJsonBody
Fields
shopify.admin: FulfillmentIdUpdateTrackingJsonBody
Fields
shopify.admin: FulfillmentList
Fields
- fulfillments? FulfillmentListFulfillments[] -
shopify.admin: FulfillmentListForOrder
Fields
- fulfillments? SingleFulfillmentFulfillment[] -
shopify.admin: FulfillmentListFulfillments
Fields
- createdAt? string -
- lineItems? FulfillmentListLineItems[] -
- trackingCompany? string -
- trackingUrls? string[] -
- locationId? int -
- updatedAt? string -
- 'service? string -
- adminGraphqlApiId? string -
- name? string -
- trackingNumber? string -
- receipt? record {} -
- id? int -
- trackingNumbers? string[] -
- orderId? int -
- trackingUrl? string -
- shipmentStatus? anydata? -
- status? string -
shopify.admin: FulfillmentListLineItems
Fields
- variantTitle? string? -
- fulfillmentStatus? string -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? anydata? -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderTotalDiscountsSet -
- properties? anydata[] -
shopify.admin: FulfillmentOrder
Fields
- fulfillmentOrder? FulfillmentOrderFulfillmentOrder -
shopify.admin: FulfillmentOrderFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? FulfillmentOrderFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? FulfillmentOrderFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: FulfillmentOrderFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: FulfillmentOrderFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: FulfillmentOrderIdCancelJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcancelJsonFulfillmentOrder -
shopify.admin: FulfillmentOrderIdCancellationRequestJsonBody
Fields
shopify.admin: FulfillmentOrderIdCloseJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdcloseJsonFulfillmentOrder -
shopify.admin: FulfillmentOrderIdFulfillmentRequestJsonBody
Fields
shopify.admin: FulfillmentOrderIdHoldJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder -
shopify.admin: FulfillmentOrderIdMoveJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder -
shopify.admin: FulfillmentOrderIdOpenJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder -
shopify.admin: FulfillmentOrderIdReleaseHoldJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder -
shopify.admin: FulfillmentOrderIdRescheduleJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder -
shopify.admin: FulfillmentOrders
Fields
- fulfillmentOrders? FulfillmentOrdersFulfillmentOrders[] -
shopify.admin: FulfillmentOrdersAssignedLocation
Fields
- zip? anydata? -
- countryCode? string -
- province? anydata? -
- address2? anydata? -
- city? anydata? -
- phone? anydata? -
- address1? anydata? -
- name? string -
- locationId? int -
shopify.admin: FulfillmentOrdersDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: FulfillmentOrdersFulfillmentOrders
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? FulfillmentOrdersDestination -
- assignedLocationId? int -
- id? int -
- lineItems? FulfillmentOrdersLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- status? string -
shopify.admin: FulfillmentOrdersLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: FulfillmentOrdersList
Fields
- fulfillmentOrders? FulfillmentOrdersListFulfillmentOrders[] -
shopify.admin: FulfillmentOrdersListDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: FulfillmentOrdersListFulfillmentOrders
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? FulfillmentOrdersListDestination -
- assignedLocationId? int -
- id? int -
- lineItems? FulfillmentOrdersListLineItems[] -
- orderId? int -
- supportedActions? string[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: FulfillmentOrdersListLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: FulfillmentOrdersSetFulfillmentOrdersDeadlineJsonBody
Fields
- fulfillmentOrder? AdminapiapiVersionfulfillmentOrdersfulfillmentOrderIdholdJsonFulfillmentOrder -
shopify.admin: FulfillmentRequestAcceptJsonBody
Fields
shopify.admin: FulfillmentRequestRejectJsonBody
Fields
shopify.admin: FulfillmentServicesfulfillmentServiceIdJsonBody
Fields
- fulfillmentService? AdminapiapiVersionfulfillmentServicesfulfillmentServiceIdJsonFulfillmentService -
shopify.admin: FulfillmentServicesList
Fields
- fulfillmentServices? SingleFulfillmentServiceFulfillmentService[] -
shopify.admin: GiftCard
Fields
- giftCard? GiftCardGiftCard -
shopify.admin: GiftCardGiftCard
Fields
- note? string? -
- initialValue? string -
- code? string -
- lineItemId? anydata? -
- apiClientId? int -
- disabledAt? anydata? -
- expiresOn? anydata? -
- createdAt? string -
- templateSuffix? string? -
- balance? string -
- updatedAt? string -
- userId? anydata? -
- currency? string -
- id? int -
- customerId? anydata? -
- lastCharacters? string -
- orderId? anydata? -
shopify.admin: GiftCardIdDisableJsonBody
Fields
shopify.admin: GiftCardSearch
Fields
- giftCards? GiftCardSearchGiftCards[] -
shopify.admin: GiftCardSearchGiftCards
Fields
- note? anydata? -
- initialValue? string -
- lineItemId? anydata? -
- apiClientId? anydata? -
- disabledAt? anydata? -
- expiresOn? anydata? -
- createdAt? string -
- templateSuffix? anydata? -
- balance? string -
- updatedAt? string -
- userId? anydata? -
- currency? string -
- id? int -
- customerId? anydata? -
- lastCharacters? string -
- orderId? anydata? -
shopify.admin: GiftCardsgiftCardIdJsonBody
Fields
shopify.admin: GiftCardsList
Fields
- giftCards? GiftCardsListGiftCards[] -
shopify.admin: GiftCardsListGiftCards
Fields
- note? anydata? -
- initialValue? string -
- lineItemId? anydata? -
- apiClientId? anydata? -
- disabledAt? anydata? -
- expiresOn? string? -
- createdAt? string -
- templateSuffix? anydata? -
- balance? string -
- updatedAt? string -
- userId? anydata? -
- currency? string -
- id? int -
- customerId? anydata? -
- lastCharacters? string -
- orderId? anydata? -
shopify.admin: ImageAsset
Fields
- asset? ImageAssetAsset -
shopify.admin: ImageAssetAsset
Fields
- publicUrl? string? -
- contentType? string -
- size? int -
- updatedAt? string -
- themeId? int -
- createdAt? string -
- 'key? string -
shopify.admin: ImagesimageIdJsonBody
Fields
shopify.admin: InventoryItem
Fields
- inventoryItem? InventoryItemInventoryItem -
shopify.admin: InventoryItemInventoryItem
Fields
- cost? string -
- updatedAt? string -
- requiresShipping? boolean -
- adminGraphqlApiId? string -
- createdAt? string -
- provinceCodeOfOrigin? anydata? -
- tracked? boolean -
- countryCodeOfOrigin? anydata? -
- id? int -
- sku? string? -
- countryHarmonizedSystemCodes? anydata[] -
- harmonizedSystemCode? anydata? -
shopify.admin: InventoryItemsinventoryItemIdJsonBody
Fields
- inventoryItem? AdminapiapiVersioninventoryItemsinventoryItemIdJsonInventoryItem -
shopify.admin: InventoryLevel
Fields
- inventoryLevel? InventoryLevelInventoryLevel -
shopify.admin: InventoryLevelInventoryLevel
Fields
- updatedAt? string -
- inventoryItemId? int -
- adminGraphqlApiId? string -
- available? int -
- locationId? int -
shopify.admin: InventoryLevels
Fields
- inventoryLevels? InventoryLevelsInventoryLevels[] -
shopify.admin: InventoryLevelsAdjustJsonBody
Fields
- inventoryItemId? int -
- availableAdjustment? int -
- locationId? int -
shopify.admin: InventoryLevelsConnectJsonBody
Fields
- inventoryItemId? int -
- locationId? int -
shopify.admin: InventoryLevelsInventoryLevels
Fields
- updatedAt? string -
- inventoryItemId? int -
- adminGraphqlApiId? string -
- available? int -
- locationId? int -
shopify.admin: InventoryLevelsSetJsonBody
Fields
- inventoryItemId? int -
- available? int -
- locationId? int -
shopify.admin: InventoryListResponse
Fields
- inventoryLevels? InventoryListResponseInventoryLevels[] -
shopify.admin: InventoryListResponseInventoryLevels
Fields
- updatedAt? string -
- inventoryItemId? int -
- adminGraphqlApiId? string -
- available? int -
- locationId? int -
shopify.admin: InvoiceResponse
Fields
- draftOrderInvoice? InvoiceResponseDraftOrderInvoice -
shopify.admin: InvoiceResponseDraftOrderInvoice
Fields
- customMessage? string -
- bcc? string[] -
- subject? string -
- 'from? string -
- to? string -
shopify.admin: LocationList
Fields
- locations? LocationListLocations[] -
shopify.admin: LocationListLocations
Fields
- zip? string? -
- country? string -
- legacy? boolean -
- address2? anydata? -
- city? string? -
- address1? string? -
- active? boolean -
- createdAt? string -
- provinceCode? string? -
- countryCode? string -
- province? string? -
- updatedAt? string -
- phone? anydata? -
- adminGraphqlApiId? string -
- countryName? string -
- name? string -
- id? int -
shopify.admin: LocationsList
Fields
- locationsForMove? LocationsListLocationsForMove[] -
shopify.admin: LocationsListLocation
Fields
- name? string -
- id? int -
shopify.admin: LocationsListLocationsForMove
Fields
- movable? boolean -
- location? LocationsListLocation -
- message? string -
shopify.admin: MarkCommentResponse
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? string -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: MarketingEvent
Fields
- marketingEvent? MarketingEventMarketingEvent -
shopify.admin: MarketingEventIdEngagementsJsonBody
Fields
shopify.admin: MarketingEventMarketingEvent
Fields
- manageUrl? anydata? -
- utmCampaign? string -
- remoteId? string -
- utmMedium? string -
- description? anydata? -
- eventType? string -
- previewUrl? anydata? -
- adminGraphqlApiId? string -
- paid? boolean -
- marketingActivityId? anydata? -
- startedAt? string -
- currency? string -
- id? int -
- marketingChannel? string -
- marketedResources? anydata[] -
- scheduledToEndAt? anydata? -
- budgetType? string -
- endedAt? anydata? -
- budget? string -
- referringDomain? string -
- utmSource? string -
shopify.admin: MarketingEvents
Fields
- marketingEvents? MarketingEventMarketingEvent[] -
shopify.admin: MarketingEventsmarketingEventIdJsonBody
Fields
- marketingEvent? AdminapiapiVersionmarketingEventsmarketingEventIdJsonMarketingEvent -
shopify.admin: Metafield
Fields
- updatedAt string -
- ownerId int -
- adminGraphqlApiId string -
- namespace string -
- description? string? -
- createdAt string -
- id int -
- 'type string -
- value string -
- ownerResource string -
- 'key string -
shopify.admin: MetafieldList
Fields
- metafields Metafield[] -
shopify.admin: MetafieldResponse
Fields
- metafield? Metafield -
shopify.admin: MobilePlatformApplication
Fields
- mobilePlatformApplication? MobilePlatformApplicationMobilePlatformApplication -
shopify.admin: MobilePlatformApplicationMobilePlatformApplication
Fields
- updatedAt? string -
- createdAt? string -
- sha256CertFingerprints? string[] -
- enabledAppClips? boolean -
- enabledUniversalOrAppLinks? boolean -
- id? int -
- appClipApplicationId? anydata? -
- applicationId? string -
- platform? string -
shopify.admin: MobilePlatformApplicationResponse
Fields
- mobilePlatformApplication? MobilePlatformApplicationResponseMobilePlatformApplication -
shopify.admin: MobilePlatformApplicationResponseMobilePlatformApplication
Fields
- updatedAt? string -
- createdAt? string -
- sha256CertFingerprints? anydata[] -
- enabledAppClips? boolean -
- enabledUniversalOrAppLinks? boolean -
- id? int -
- appClipApplicationId? anydata? -
- applicationId? string -
- platform? string -
shopify.admin: MobilePlatformApplications
Fields
- mobilePlatformApplications? MobilePlatformApplicationsMobilePlatformApplications[] -
shopify.admin: MobilePlatformApplicationsmobilePlatformApplicationIdJsonBody
Fields
- mobilePlatformApplication? AdminapiapiVersionmobilePlatformApplicationsmobilePlatformApplicationIdJsonMobilePlatformApplication -
shopify.admin: MobilePlatformApplicationsMobilePlatformApplications
Fields
- updatedAt? string -
- createdAt? string -
- sha256CertFingerprints? anydata[] -
- enabledAppClips? boolean -
- enabledUniversalOrAppLinks? boolean -
- id? int -
- appClipApplicationId? anydata? -
- applicationId? string -
- platform? string -
shopify.admin: ModifyDraftOrder
Fields
- draftOrder? ModifyDraftOrderDraftOrder -
shopify.admin: ModifyDraftOrderDraftOrder
Fields
- note? string? -
- appliedDiscount? ModifyDraftOrderDraftOrderAppliedDiscount? -
- createdAt? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ModifyDraftOrderDraftOrderLineItems[] -
- taxesIncluded? boolean -
- taxLines? anydata[] -
- updatedAt? string -
- currency? string -
- id? int -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- email? string -
- subtotalPrice? string -
- totalPrice? string -
- taxExempt? boolean -
- invoiceSentAt? anydata? -
- totalTax? string -
- completedAt? anydata? -
- adminGraphqlApiId? string -
- noteAttributes? anydata[] -
- name? string -
- shippingLine? ModifyDraftOrderDraftOrderShippingLine? -
- orderId? anydata? -
- invoiceUrl? string -
- customer? AbandonedCheckoutsCustomer -
- status? string -
shopify.admin: ModifyDraftOrderDraftOrderAppliedDiscount
Fields
- amount? string -
- valueType? string -
- description? string -
- title? string? -
- value? string -
shopify.admin: ModifyDraftOrderDraftOrderLineItems
Fields
- variantTitle? string? -
- quantity? int -
- appliedDiscount? anydata? -
- fulfillmentService? string -
- giftCard? boolean -
- taxable? boolean -
- requiresShipping? boolean -
- custom? boolean -
- title? string -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? anydata? -
- adminGraphqlApiId? string -
- productId? int? -
- name? string -
- grams? int -
- sku? string? -
- properties? anydata[] -
shopify.admin: ModifyDraftOrderDraftOrderShippingLine
Fields
- price? string -
- custom? boolean -
- 'handle? string -
- title? string -
shopify.admin: ModifyProductImage
Fields
- image? ModifyProductImageImage -
shopify.admin: ModifyProductImageImage
Fields
- updatedAt? string -
- src? string -
- adminGraphqlApiId? string -
- productId? int? -
- alt? string? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: ModifyProductVariant
Fields
- variant? ModifyProductVariantVariant -
shopify.admin: ModifyProductVariantVariant
Fields
- presentmentPrices? ProductVariantsPresentmentPrices[] -
- inventoryManagement? string -
- oldInventoryQuantity? int -
- requiresShipping? boolean -
- createdAt? string -
- title? string -
- updatedAt? string -
- inventoryItemId? int -
- price? string -
- productId? int? -
- option3? anydata? -
- option1? string -
- id? int -
- option2? anydata? -
- grams? int -
- sku? string? -
- barcode? string -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- taxable? boolean -
- weight? decimal -
- inventoryPolicy? string -
- weightUnit? string -
- adminGraphqlApiId? string -
- position? int -
- imageId? int -
shopify.admin: MoveFulfillmentOrderResponse
Fields
- originalFulfillmentOrder? MoveFulfillmentOrderResponseOriginalFulfillmentOrder -
- remainingFulfillmentOrder? anydata? -
- movedFulfillmentOrder? MoveFulfillmentOrderResponseMovedFulfillmentOrder -
shopify.admin: MoveFulfillmentOrderResponseMovedFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? MoveFulfillmentOrderResponseMovedFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? MoveFulfillmentOrderResponseMovedFulfillmentOrderLineItems[] -
- orderId? int -
- supportedActions? string[] -
- assignedLocation? MoveFulfillmentOrderResponseMovedFulfillmentOrderAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: MoveFulfillmentOrderResponseMovedFulfillmentOrderAssignedLocation
Fields
- zip? string -
- countryCode? string -
- province? string -
- address2? anydata? -
- city? string -
- phone? anydata? -
- address1? string -
- name? string -
- locationId? int -
shopify.admin: MoveFulfillmentOrderResponseMovedFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: MoveFulfillmentOrderResponseMovedFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: MoveFulfillmentOrderResponseOriginalFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- assignedLocationId? int -
- id? int -
- orderId? int -
- supportedActions? anydata[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: MoveFulfillmentOrderResponseOriginalFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: MoveFulfillmentOrderResponseOriginalFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: ObjectCount
Fields
- count? int -
shopify.admin: Option
The custom properties that a shop owner uses to define product variants. You can define three options for a product variant are option1, option2, option3. Default value is Default Title. The title field is a concatenation of the option1, option2, and option3 fields. Updating the option fields updates the title field
Fields
- option3? string - Option 3
- option1? string - Option 1
- option2? string - Option 2
shopify.admin: Order
Fields
- 'order? ReopenCloseOrderOrder -
shopify.admin: OrderAdjustment
Order adjustment attached to the refund
Fields
- taxAmount? string - The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund
- reason? string - The reason for the order adjustment. To set this value, include discrepancy_reason when you create a refund
- kind? string - The order adjustment type. Valid values are shipping_refund and refund_discrepancy
- id? int - The unique identifier for the order adjustment
- orderId? int - The unique identifier for the order that the order adjustment is associated with
- refundId? int - The unique identifier for the refund that the order adjustment is associated with
shopify.admin: OrderResponse
Fields
- 'order? OrderResponseOrder -
shopify.admin: OrderResponseOrder
Fields
- cancelledAt? anydata? -
- fulfillmentStatus? string? -
- totalPriceUsd? string -
- billingAddress? OrderResponseOrderBillingAddress? -
- lineItems? OrderResponseOrderLineItems[] -
- presentmentCurrency? string -
- totalDiscountsSet? ReopenCloseOrderOrderTotalDiscountSet -
- locationId? anydata? -
- sourceUrl? anydata? -
- landingSite? anydata? -
- sourceIdentifier? anydata? -
- reference? anydata? -
- number? int -
- checkoutId? anydata? -
- checkoutToken? anydata? -
- taxLines? anydata[] -
- customerLocale? anydata? -
- id? int -
- appId? int -
- subtotalPrice? string -
- closedAt? anydata? -
- orderStatusUrl? string -
- deviceId? anydata? -
- test? boolean -
- totalShippingPriceSet? ReopenCloseOrderOrderTotalDiscountSet -
- subtotalPriceSet? ReopenCloseOrderOrderPriceSet -
- paymentGatewayNames? string[] -
- totalTax? string -
- processingMethod? string -
- shippingLines? anydata[] -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? anydata[] -
- name? string -
- cartToken? anydata? -
- totalTaxSet? ReopenCloseOrderOrderTotalDiscountSet -
- landingSiteRef? anydata? -
- discountCodes? anydata[] -
- note? anydata? -
- orderNumber? int -
- discountApplications? anydata[] -
- createdAt? string -
- totalLineItemsPriceSet? ReopenCloseOrderOrderPriceSet -
- taxesIncluded? boolean -
- buyerAcceptsMarketing? boolean -
- confirmed? boolean -
- totalWeight? int -
- contactEmail? string? -
- refunds? anydata[] -
- totalDiscounts? string -
- fulfillments? anydata[] -
- referringSite? anydata? -
- updatedAt? string -
- processedAt? string -
- currency? string -
- shippingAddress? OrderResponseOrderShippingAddress? -
- browserIp? anydata? -
- email? string -
- sourceName? string -
- totalPriceSet? ReopenCloseOrderOrderPriceSet -
- totalPrice? string -
- totalLineItemsPrice? string -
- token? string -
- cancelReason? anydata? -
- adminGraphqlApiId? string -
- financialStatus? string -
- gateway? string -
- customer? OrderResponseOrderCustomer -
shopify.admin: OrderResponseOrderBillingAddress
Fields
- zip? string -
- country? string -
- address2? anydata? -
- city? string -
- address1? string -
- latitude? anydata? -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- name? string -
- company? anydata? -
- firstName? string -
- longitude? anydata? -
shopify.admin: OrderResponseOrderCustomer
Fields
- totalSpent? string -
- note? anydata? -
- lastOrderName? string -
- lastOrderId? int -
- taxExempt? boolean -
- createdAt? string -
- lastName? string? -
- multipassIdentifier? anydata? -
- verifiedEmail? boolean -
- acceptsMarketingUpdatedAt? string -
- ordersCount? int -
- defaultAddress? OrderResponseOrderCustomerDefaultAddress -
- updatedAt? string -
- acceptsMarketing? boolean -
- phone? anydata? -
- adminGraphqlApiId? string -
- taxExemptions? anydata[] -
- currency? string -
- id? int -
- marketingOptInLevel? anydata? -
- state? string -
- firstName? string? -
- email? string -
shopify.admin: OrderResponseOrderCustomerDefaultAddress
Fields
- zip? string -
- country? string -
- address2? string? -
- city? string -
- address1? string -
- lastName? string? -
- provinceCode? string -
- countryCode? string -
- default? boolean -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? anydata? -
- id? int -
- customerId? int -
- firstName? string? -
shopify.admin: OrderResponseOrderLineItems
Fields
- variantTitle? string? -
- fulfillmentStatus? anydata? -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? anydata[] -
- price? string -
- vendor? string -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? string -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderPriceSet -
- properties? anydata[] -
shopify.admin: OrderResponseOrderShippingAddress
Fields
- zip? string -
- country? string -
- address2? anydata? -
- city? string -
- address1? string -
- latitude? anydata? -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- name? string -
- company? anydata? -
- firstName? string -
- longitude? anydata? -
shopify.admin: OrderRisk
The order risk for an order
Fields
- score? string - A number between 0 and 1 that's assigned to the order. The closer the score is to 1, the more likely it is that the order is fraudulent
- checkoutId? int - The ID of the checkout that the order risk belongs to
- display? boolean - Whether the order risk is displayed on the order details page in the Shopify admin. If false, then this order risk is ignored when Shopify determines your app's overall risk level for the order
- recommendation? "cancel"|"investigate"|"accept" - The recommended action given to the merchant. Valid values are,
cancel- There is a high level of risk that this order is fraudulent. The merchant should cancel the order.investigate- There is a medium level of risk that this order is fraudulent. The merchant should investigate the order.accept- There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud
- causeCancel? boolean - Whether this order risk is severe enough to force the cancellation of the order. If true, then this order risk is included in the Order canceled message that's shown on the details page of the canceled order
- merchantMessage? string - The message that's displayed to the merchant to indicate the results of the fraud check. The message is displayed only if display is set to true
- id? int - A unique numeric identifier for the order risk
- 'source? string - The source of the order risk
- message? string - The message that's displayed to the merchant to indicate the results of the fraud check. The message is displayed only if display is set to true
- orderId? int - The ID of the order that the order risk belongs to
shopify.admin: OrderRiskObject
The order risk object for an order
Fields
- risk? OrderRisk - The order risk for an order
shopify.admin: OrderRisks
Fields
- risks? OrderRisksRisks[] -
shopify.admin: OrderRisksRisks
Fields
- score? string -
- checkoutId? int? -
- display? boolean -
- recommendation? string -
- causeCancel? boolean -
- merchantMessage? string -
- id? int -
- 'source? string -
- message? string -
- orderId? int -
shopify.admin: Orders
Fields
- orders? Order[]? -
shopify.admin: OrdersList
Fields
- orders? OrdersListOrders[] -
shopify.admin: OrdersListOrders
Fields
- totalPrice? string -
- name? string -
- createdAt? string -
- id? int -
shopify.admin: OriginalFulfillmentOrder
Fields
- submittedFulfillmentOrder? OriginalFulfillmentOrderSubmittedFulfillmentOrder -
- originalFulfillmentOrder? OriginalFulfillmentOrderOriginalFulfillmentOrder -
- unsubmittedFulfillmentOrder? OriginalFulfillmentOrderUnsubmittedFulfillmentOrder? -
shopify.admin: OriginalFulfillmentOrderOriginalFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? OriginalFulfillmentOrderOriginalFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? OriginalFulfillmentOrderOriginalFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? anydata[] -
- status? string -
shopify.admin: OriginalFulfillmentOrderOriginalFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: OriginalFulfillmentOrderOriginalFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: OriginalFulfillmentOrderSubmittedFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? OriginalFulfillmentOrderSubmittedFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? OriginalFulfillmentOrderSubmittedFulfillmentOrderLineItems[] -
- outgoingRequests? OriginalFulfillmentOrderSubmittedFulfillmentOrderOutgoingRequests[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: OriginalFulfillmentOrderSubmittedFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: OriginalFulfillmentOrderSubmittedFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: OriginalFulfillmentOrderSubmittedFulfillmentOrderOutgoingRequests
Fields
- sentAt? string -
- requestOptions? OriginalFulfillmentOrderSubmittedFulfillmentOrderRequestOptions -
- kind? string -
- message? string -
shopify.admin: OriginalFulfillmentOrderSubmittedFulfillmentOrderRequestOptions
Fields
- notifyCustomer? boolean -
shopify.admin: OriginalFulfillmentOrderUnsubmittedFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- assignedLocationId? int -
- id? int -
- lineItems? OriginalFulfillmentOrderUnsubmittedFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: OriginalFulfillmentOrderUnsubmittedFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: OriginalFulfillmentOrderUnsubmittedFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: OwnerResourceMetafieldsJsonBody
Fields
shopify.admin: PageResponse
Fields
- page? PageResponsePage -
shopify.admin: PageResponsePage
Fields
- shopId? int -
- bodyHtml? string -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- createdAt? string -
- 'handle? string -
- id? int -
- publishedAt? string? -
- title? string -
shopify.admin: PagesListResponse
Fields
- pages? PagesListResponsePages[] -
shopify.admin: PagesListResponsePages
Fields
- shopId? int -
- bodyHtml? string? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- createdAt? string -
- 'handle? string -
- id? int -
- publishedAt? string -
- title? string -
shopify.admin: PagespageIdJsonBody
Fields
shopify.admin: PaymentsResponse
Fields
- payments? PaymentsResponsePayments[] -
shopify.admin: PaymentsResponseCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? SinglePaymentResponsePaymentCheckoutTaxLines[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? SinglePaymentResponsePaymentCheckoutShippingRate -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? SinglePaymentResponsePaymentCheckoutShippingLine? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? PaymentsResponseCheckoutPayments[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? SinglePaymentResponsePaymentCheckoutCreditCard -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: PaymentsResponseCheckoutPayments
Fields
- uniqueToken? string -
- creditCard? anydata? -
- paymentProcessingErrorMessage? anydata? -
- id? int -
- 'transaction? PaymentsResponseCheckoutTransaction -
shopify.admin: PaymentsResponseCheckoutTransaction
Fields
- amountIn? anydata? -
- amount? string -
- test? boolean -
- kind? string -
- createdAt? string -
- message? anydata? -
- amountOut? anydata? -
- parentId? anydata? -
- amountRounding? anydata? -
- currency? string -
- errorCode? anydata? -
- id? int -
- gateway? string -
- status? string -
shopify.admin: PaymentsResponsePayments
Fields
- uniqueToken? string -
- creditCard? anydata? -
- paymentProcessingErrorMessage? anydata? -
- id? int -
- checkout? PaymentsResponseCheckout -
- 'transaction? PaymentsResponseCheckoutTransaction -
shopify.admin: PayoutsList
Fields
- payouts? PayoutsListPayouts[] -
shopify.admin: PayoutsListPayouts
Fields
- date? string -
- summary? PayoutsListSummary -
- amount? string -
- currency? string -
- id? int -
- status? string -
shopify.admin: PayoutsListSummary
Fields
- chargesGrossAmount? string -
- reservedFundsGrossAmount? string -
- retriedPayoutsGrossAmount? string -
- chargesFeeAmount? string -
- adjustmentsGrossAmount? string -
- reservedFundsFeeAmount? string -
- refundsFeeAmount? string -
- retriedPayoutsFeeAmount? string -
- adjustmentsFeeAmount? string -
- refundsGrossAmount? string -
shopify.admin: PostalCodeResult
Fields
- customerAddress? PostalCodeResultCustomerAddress -
shopify.admin: PostalCodeResultCustomerAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? anydata? -
- provinceCode? string -
- countryCode? string -
- default? boolean -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? anydata? -
- id? int -
- customerId? int -
- firstName? anydata? -
shopify.admin: PresentmentPrice
The variant's presentment prices and compare-at prices in each of the shop's enabled presentment currencies
Fields
- compareAtPrice? Price -
- price? Price - The price object
shopify.admin: PresentmentPrices
The variant's presentment prices and compare-at prices in each of the shop's enabled presentment currencies
Fields
- presentmentPrices? PresentmentPrice[] - A list of the variant's presentment prices and compare-at prices in each of the shop's enabled presentment currencies
shopify.admin: Price
The price object
Fields
- amount? string - The variant's price or compare-at price in the presentment currency
- currencyCode? string - The three-letter code (ISO 4217 format) for one of the shop's enabled presentment currencies
shopify.admin: PriceBasedShippingRate
Fields
- shippingZoneId? int -
- price? decimal -
- minOrderSubtotal? decimal? -
- name? string -
- id? int -
- maxOrderSubtotal? decimal? -
shopify.admin: PriceRule
Fields
- priceRule? PriceRulePriceRule -
shopify.admin: PriceRuleIdBatchJsonBody
Fields
- discountCodes? AdminapiapiVersionpriceRulespriceRuleIdbatchJsonDiscountCodes[] -
shopify.admin: PriceRuleIdDiscountCodesJsonBody
Fields
shopify.admin: PriceRulePriceRule
Fields
- oncePerCustomer? boolean -
- startsAt? string -
- usageLimit? int? -
- valueType? string -
- createdAt? string -
- prerequisiteCustomerIds? anydata[] -
- title? string -
- entitledCollectionIds? int[] -
- updatedAt? string -
- prerequisiteProductIds? anydata[] -
- prerequisiteShippingPriceRange? anydata? -
- entitledCountryIds? anydata[] -
- entitledVariantIds? anydata[] -
- endsAt? anydata? -
- id? int -
- value? string -
- prerequisiteSubtotalRange? record {}? -
- allocationMethod? string -
- prerequisiteToEntitlementQuantityRatio? PriceRulePriceRulePrerequisiteToEntitlementQuantityRatio -
- prerequisiteQuantityRange? anydata? -
- allocationLimit? int? -
- targetType? string -
- entitledProductIds? anydata[] -
- customerSelection? string -
- prerequisiteSavedSearchIds? anydata[] -
- adminGraphqlApiId? string -
- prerequisiteVariantIds? anydata[] -
- targetSelection? string -
- prerequisiteCollectionIds? anydata[] -
shopify.admin: PriceRulePriceRulePrerequisiteToEntitlementQuantityRatio
Fields
- prerequisiteQuantity? int? -
- entitledQuantity? int? -
shopify.admin: PriceRules
Fields
- priceRules? SinglePriceRulePriceRule[] -
shopify.admin: PriceRulespriceRuleIdJsonBody
Fields
- priceRule? AdminapiapiVersionpriceRulespriceRuleIdJsonPriceRule -
shopify.admin: Product
The Product resource lets you update and create products in a merchant's store
Fields
- bodyHtml? string - A description of the product. Supports HTML formatting
- images? ProductImage[] - A list of product image objects, each one representing an image associated with the product
- createdAt? string - The date and time (ISO 8601 format) when the product was created
- 'handle? string - A unique human-friendly string for the product. Automatically generated from the product's title. Used by the Liquid templating language to refer to objects
- variants? ProductVariant[] - An array of product variants, each representing a different version of the product. The position property is read-only. The position of variants is indicated by the order in which they are listed
- title? string - The name of the product
- publishedScope? string - Whether the product is published to the Point of Sale channel
- productType? string - A categorization for the product used for filtering and searching products
- templateSuffix? string - The suffix of the Liquid template used for the product page. If this property is specified, then the product page uses a template called "product.suffix.liquid", where "suffix" is the value of this property. If this property is "" or null, then the product page uses the default template "product.liquid". (default is null)
- updatedAt? string - The date and time (ISO 8601 format) when the product was last modified. A product's updated_at value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update
- vendor? string - The name of the product's vendor
- options? ProductOption[] - The custom product properties. For example, Size, Color, and Material. Each product can have up to 3 options and each option value can be up to 255 characters. Product variants are made of up combinations of option values. Options cannot be created without values. To create new options, a variant with an associated option value also needs to be created
- id? int - An unsigned 64-bit integer that's used as a unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id, even if they're from different shops
- publishedAt? string - The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel
- status? string - The status of the product
shopify.admin: ProductIdAppResponse
Fields
- productIds? decimal[] -
shopify.admin: ProductIdImagesJsonBody
Fields
shopify.admin: ProductIdResourceFeedbackJsonBody
Fields
- resourceFeedback? AdminapiapiVersionproductsproductIdresourceFeedbackJsonResourceFeedback -
shopify.admin: ProductIds
Fields
- productIds? int[] -
shopify.admin: ProductImage
Products are easier to sell if customers can see pictures of them, which is why there are product images
Fields
- updatedAt? string - The date and time when the product image was last modified. The API returns this value in ISO 8601 format
- src? string - Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png)
- productId? int - The id of the product associated with the image
- width? int - Width dimension of the image which is determined on upload
- createdAt? string - The date and time when the product image was created. The API returns this value in ISO 8601 formatting
- variantIds? int[] - An array of variant ids associated with the image
- id? int - A unique numeric identifier for the product image
- position? int - The order of the product image in the list. The first product image is at position 1 and is the "main" image for the product
- height? int - Height dimension of the image which is determined on upload
shopify.admin: ProductImages
Fields
- images? ProductImagesImages[] -
shopify.admin: ProductImagesImages
Fields
- updatedAt? string -
- src? string -
- adminGraphqlApiId? string -
- productId? int? -
- alt? anydata? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: ProductListingAppResponse
Fields
- productListing? ProductListingAppResponseProductListing -
shopify.admin: ProductListingAppResponseProductListing
Fields
- bodyHtml? string -
- images? anydata[] -
- available? boolean -
- createdAt? string -
- 'handle? string -
- variants? ProductListingAppResponseProductListingVariants[] -
- title? string -
- productType? string -
- updatedAt? string -
- vendor? string -
- productId? int? -
- options? ProductListingAppResponseProductListingOptions[] -
- publishedAt? string -
shopify.admin: ProductListingAppResponseProductListingOptions
Fields
- productId? int? -
- values? string[] -
- name? string -
- id? int -
- position? int -
shopify.admin: ProductListingAppResponseProductListingOptionValues
Fields
- name? string -
- optionId? int -
- value? string -
shopify.admin: ProductListingAppResponseProductListingVariants
Fields
- formattedPrice? string -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- inventoryManagement? string -
- taxable? boolean -
- requiresShipping? boolean -
- optionValues? ProductListingAppResponseProductListingOptionValues[] -
- available? boolean -
- createdAt? string -
- weight? decimal -
- title? string -
- inventoryPolicy? string -
- updatedAt? string -
- weightUnit? string -
- price? string -
- id? int -
- position? int -
- grams? int -
- imageId? anydata? -
- sku? string? -
- barcode? string -
shopify.admin: ProductListings
Fields
- productListings? ProductListingsProductListings[] -
shopify.admin: ProductListingsImages
Fields
- updatedAt? string -
- src? string -
- productId? int? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: ProductListingsOptions
Fields
- productId? int? -
- values? string[] -
- name? string -
- id? int -
- position? int -
shopify.admin: ProductListingsOptionValues
Fields
- name? string -
- optionId? int -
- value? string -
shopify.admin: ProductListingsproductListingIdJsonBody
Fields
- productListing? AdminapiapiVersionproductListingsproductListingIdJsonProductListing -
shopify.admin: ProductListingsProductListings
Fields
- bodyHtml? string? -
- images? ProductListingsImages[] -
- available? boolean -
- createdAt? string -
- 'handle? string -
- variants? ProductListingsVariants[] -
- title? string -
- productType? string -
- updatedAt? string -
- vendor? string -
- productId? int? -
- options? ProductListingsOptions[] -
- publishedAt? string -
shopify.admin: ProductListingsVariants
Fields
- formattedPrice? string -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- inventoryManagement? string -
- taxable? boolean -
- requiresShipping? boolean -
- optionValues? ProductListingsOptionValues[] -
- available? boolean -
- createdAt? string -
- weight? decimal -
- title? string -
- inventoryPolicy? string -
- updatedAt? string -
- weightUnit? string -
- price? string -
- id? int -
- position? int -
- grams? int -
- imageId? int? -
- sku? string? -
- barcode? string -
shopify.admin: ProductObject
Fields
- product? Product - The Product resource lets you update and create products in a merchant's store
shopify.admin: ProductOption
The custom product properties. For example, Size, Color, and Material. Each product can have up to 3 options and each option value can be up to 255 characters
Fields
- productId? int - Product option product ID
- values? string[] - Product option values
- name? string - Product option name
- id? int - Product option ID
- position? int - Product option position
shopify.admin: ProductsList
Fields
- products? ProductsListProducts[] -
shopify.admin: ProductsListOptions
Fields
- productId? int? -
- name? string -
- id? int -
- position? int -
shopify.admin: ProductsListProducts
Fields
- image? ProductsResponseImages -
- bodyHtml? string? -
- images? ProductsResponseImages[] -
- createdAt? string -
- 'handle? string -
- title? string -
- publishedScope? string -
- productType? string -
- templateSuffix? anydata? -
- updatedAt? string -
- vendor? string -
- adminGraphqlApiId? string -
- options? ProductsListOptions[] -
- id? int -
- publishedAt? string -
shopify.admin: ProductsResponse
Fields
- products? ProductsResponseProducts[] -
shopify.admin: ProductsResponseImages
Fields
- updatedAt? string -
- src? string -
- adminGraphqlApiId? string -
- productId? int? -
- alt? anydata? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: ProductsResponseProducts
Fields
- images? ProductsResponseImages[] -
- id? int -
- title? string -
shopify.admin: ProductToCollectionResponse
Fields
- collect? ProductToCollectionResponseCollect -
shopify.admin: ProductToCollectionResponseCollect
Fields
- collectionId? int -
- updatedAt? string -
- productId? int? -
- createdAt? string -
- id? int -
- position? int -
- sortValue? string -
shopify.admin: ProductVariant
A variant can be added to a Product resource to represent one version of a product with several options. The Product resource will have a variant for every possible combination of its options. Each product can have a maximum of three options and a maximum of 100 variants
Fields
- presentmentPrices? PresentmentPrices - A list of the variant's presentment prices and compare-at prices in each of the shop's enabled presentment currencies.
- inventoryManagement? string - The fulfillment service that tracks the number of items in stock for the product variant
- oldInventoryQuantity? int - This property is deprecated. Use the InventoryLevel resource instead
- requiresShipping? boolean - This property is deprecated. Use the
requires_shippingproperty on the InventoryItem resource instead
- createdAt? string - The date and time (ISO 8601 format) when the product variant was created
- title? string - The title of the product variant. The title field is a concatenation of the option1, option2, and option3 fields. You can only update title indirectly using the option fields
- inventoryQuantityAdjustment? int - This property is deprecated. Use the InventoryLevel resource instead
- updatedAt? string - The date and time when the product variant was last modified. Gets returned in ISO 8601 formatting
- inventoryItemId? int - The unique identifier for the inventory item, which is used in the Inventory API to query for inventory information
- price? string - The price of the product variant
- productId? int - The unique numeric identifier for the product
- id? int - The unique numeric identifier for the product variant
- grams? int - The weight of the product variant in grams
- sku? string - A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService
- barcode? string - The barcode, UPC, or ISBN number for the product
- inventoryQuantity? int - An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource
- compareAtPrice? string - The original price of the item before an adjustment or a sale
- fulfillmentService? string - The fulfillment service associated with the product variant. Valid values are manual or the handle of a fulfillment service
- taxable? boolean - Whether a tax is charged when the product variant is sold
- weight? int - The weight of the product variant in the unit system specified with weight_unit
- inventoryPolicy? string - Whether customers are allowed to place an order for the product variant when it's out of stock
- taxCode? string - This parameter applies only to the stores that have the Avalara AvaTax app installed. Specifies the Avalara tax code for the product variant
- weightUnit? string - The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values are g, kg, oz, and lb
- position? int - The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed
- imageId? int - The unique numeric identifier for a product's image. The image must be associated to the same product as the variant
- option? Option - The custom properties that a shop owner uses to define product variants. You can define three options for a product variant are option1, option2, option3. Default value is Default Title. The title field is a concatenation of the option1, option2, and option3 fields. Updating the option fields updates the title field
shopify.admin: ProductVariantResponse
Fields
- variant? ProductVariantResponseVariant -
shopify.admin: ProductVariantResponseVariant
Fields
- presentmentPrices? ProductVariantsPresentmentPrices[] -
- inventoryManagement? string -
- oldInventoryQuantity? int -
- requiresShipping? boolean -
- createdAt? string -
- title? string -
- updatedAt? string -
- inventoryItemId? int -
- price? string -
- productId? int? -
- option3? anydata? -
- option1? string -
- id? int -
- option2? anydata? -
- grams? int -
- sku? string? -
- barcode? string -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- taxable? boolean -
- weight? decimal -
- inventoryPolicy? string -
- taxCode? string -
- weightUnit? string -
- adminGraphqlApiId? string -
- position? int -
- imageId? int -
shopify.admin: ProductVariants
Fields
- variants? ProductVariantsVariants[] -
shopify.admin: ProductVariantsPresentmentPrices
Fields
- compareAtPrice? anydata? -
shopify.admin: ProductVariantsVariants
Fields
- presentmentPrices? ProductVariantsPresentmentPrices[] -
- inventoryManagement? string -
- oldInventoryQuantity? int -
- requiresShipping? boolean -
- createdAt? string -
- title? string -
- updatedAt? string -
- inventoryItemId? int -
- price? string -
- productId? int? -
- option3? anydata? -
- option1? string -
- id? int -
- option2? anydata? -
- grams? int -
- sku? string? -
- barcode? string -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- taxable? boolean -
- weight? decimal -
- inventoryPolicy? string -
- weightUnit? string -
- adminGraphqlApiId? string -
- position? int -
- imageId? int? -
shopify.admin: ProvincesCount
Fields
- count? int -
shopify.admin: ProvincesList
Fields
- provinces? CountryResponseCountryProvinces[] -
shopify.admin: ProvincesprovinceIdJsonBody
Fields
shopify.admin: PublishThemeResponse
Fields
- theme? PublishThemeResponseTheme -
shopify.admin: PublishThemeResponseTheme
Fields
- role? string -
- updatedAt? string -
- adminGraphqlApiId? string -
- themeStoreId? anydata? -
- name? string -
- createdAt? string -
- processing? boolean -
- id? int -
- previewable? boolean -
shopify.admin: ReceiveACountOfAllDraftOrdersQueries
Represents the Queries record for the operation: receiveACountOfAllDraftOrders
Fields
- updatedAtMax? string - Count draft orders last updated before the specified date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Count draft orders last updated after the specified date (format: 2014-04-25T16:15:47-04:00).
- sinceId? string - Count draft orders after the specified ID.
- status? string - Count draft orders that have a given status.(default: open)
shopify.admin: ReceiveACountOfAllProductImagesQueries
Represents the Queries record for the operation: receiveACountOfAllProductImages
Fields
- sinceId? string - Restrict results to after the specified ID
shopify.admin: ReceiveACountOfAllWebhooksQueries
Represents the Queries record for the operation: receiveACountOfAllWebhooks
Fields
- address? string - Retrieve webhook subscriptions that send the POST request to this URI.
- topic? string - Show webhook subscriptions with a given topic. For a list of valid values, refer to the
topicproperty.>
shopify.admin: ReceiveAListOfAllCountriesQueries
Represents the Queries record for the operation: receiveAListOfAllCountries
Fields
- sinceId? string - Restrict results to after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: ReceiveAListOfAllFulfillmentServicesQueries
Represents the Queries record for the operation: receiveAListOfAllFulfillmentServices
Fields
- scope? string -
shopify.admin: ReceiveAListOfAllProductImagesQueries
Represents the Queries record for the operation: receiveAListOfAllProductImages
Fields
- sinceId? string - Restrict results to after the specified ID
- fields? string - comma-separated list of fields to include in the response
shopify.admin: ReceiveAListOfAllShippingzonesQueries
Represents the Queries record for the operation: receiveAListOfAllShippingzones
Fields
- fields? string - Show only specific fields by providing a comma-separated list of field names
shopify.admin: ReceiveASingleArticleQueries
Represents the Queries record for the operation: receiveASingleArticle
Fields
- fields? string - Show only certain fields, specifed by a comma-separated list of field names.
shopify.admin: ReceiveASingleBlogQueries
Represents the Queries record for the operation: receiveASingleBlog
Fields
- fields? string - comma-separated list of fields to include in the response
shopify.admin: ReceiveASingleDraftOrderQueries
Represents the Queries record for the operation: receiveASingleDraftOrder
Fields
- fields? string - A comma-separated list of fields to include in the response
shopify.admin: ReceiveASingleFulfillmentQueries
Represents the Queries record for the operation: receiveASingleFulfillment
Fields
- fields? string - Comma-separated list of fields to include in the response.
shopify.admin: ReceiveASingleProductImageQueries
Represents the Queries record for the operation: receiveASingleProductImage
Fields
- fields? string - comma-separated list of fields to include in the response
shopify.admin: ReceiveASingleProductVariantQueries
Represents the Queries record for the operation: receiveASingleProductVariant
Fields
- fields? string - A comma-separated list of fields to include in the response
shopify.admin: ReceiveASingleWebhookQueries
Represents the Queries record for the operation: receiveASingleWebhook
Fields
- fields? string - Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
shopify.admin: RecurringApplicationChargeIdUsageChargesJsonBody
Fields
shopify.admin: RecurringApplicationCharges
Fields
- recurringApplicationCharges? RecurringApplicationChargesRecurringApplicationCharges[] -
shopify.admin: RecurringApplicationChargesRecurringApplicationCharges
Fields
- apiClientId? int -
- test? anydata? -
- createdAt? string -
- cancelledOn? anydata? -
- trialDays? int -
- decoratedReturnUrl? string -
- updatedAt? string -
- price? string -
- trialEndsOn? anydata? -
- name? string -
- returnUrl? string -
- billingOn? string -
- currency? string -
- id? int -
- activatedOn? anydata? -
- status? string -
shopify.admin: RedirectResponse
Fields
- redirect? RedirectResponseRedirect -
shopify.admin: RedirectResponseRedirect
Fields
- path? string -
- id? int -
- target? string -
shopify.admin: RedirectsredirectIdJsonBody
Fields
shopify.admin: Refund
Schedule associated to the payment terms
Fields
- note? string - An optional note attached to a refund
- refundLineItems? RefundLineItem[] - A list of refunded line items
- userId? int - The unique identifier of the user who performed the refund
- orderAdjustments? OrderAdjustment[] - A list of order adjustments attached to the refund. Order adjustments are generated to account for refunded shipping costs and differences between calculated and actual refund amounts
- createdAt? string - The date and time (ISO 8601 format) when the refund was created
- processedAt? string - The date and time (ISO 8601 format) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in Shopify. Public apps need to be granted permission by Shopify to import orders with the processed_at timestamp set to a value earlier the created_at timestamp. Private apps can't be granted permission by Shopify
- id? int - The unique identifier for the refund
shopify.admin: RefundLineItem
Refunded line item
Fields
- lineItemId? int - The ID of the related line item in the order
- quantity? int - The quantity of the associated line item that was returned
- subtotal? decimal - The subtotal of the refund line item
- id? int - The unique identifier of the line item in the refund
- totalTax? decimal - The total tax on the refund line item
- locationId? int - The unique identifier of the location where the items will be restocked. Required when restock_type has the value return or cancel
- restockType? string - How this refund line item affects inventory levels
shopify.admin: RefundObject
The Refund object
Fields
- refund? Refund - Schedule associated to the payment terms
shopify.admin: RefundResponse
Fields
- refund? ReopenCloseOrderOrderRefunds -
shopify.admin: Refunds
Fields
- refunds? ReopenCloseOrderOrderRefunds[] -
shopify.admin: RefundsCalculateJsonBody
Fields
shopify.admin: RejectCancellationRequestResponse
Fields
- fulfillmentOrder? RejectCancellationRequestResponseFulfillmentOrder -
shopify.admin: RejectCancellationRequestResponseFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? RejectCancellationRequestResponseFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? RejectCancellationRequestResponseFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: RejectCancellationRequestResponseFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: RejectCancellationRequestResponseFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: RejectFulfillmentResponse
Fields
- fulfillmentOrder? RejectFulfillmentResponseFulfillmentOrder -
shopify.admin: RejectFulfillmentResponseFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- origin? FulfillmentOrdersAssignedLocation -
- destination? RejectFulfillmentResponseFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? RejectFulfillmentResponseFulfillmentOrderLineItems[] -
- outgoingRequests? anydata[] -
- orderId? int -
- supportedActions? string[] -
- status? string -
shopify.admin: RejectFulfillmentResponseFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: RejectFulfillmentResponseFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: RemoveCommentResponse
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? anydata? -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: ReopenCloseOrder
Fields
- 'order? ReopenCloseOrderOrder -
shopify.admin: ReopenCloseOrderOrder
Fields
- cancelledAt? anydata? -
- fulfillmentStatus? anydata? -
- totalPriceUsd? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ReopenCloseOrderOrderLineItems[] -
- presentmentCurrency? string -
- totalDiscountsSet? ReopenCloseOrderOrderTotalDiscountsSet -
- locationId? anydata? -
- sourceUrl? anydata? -
- landingSite? string -
- sourceIdentifier? string -
- reference? string -
- number? int -
- checkoutId? int -
- checkoutToken? string -
- taxLines? ReopenCloseOrderOrderTaxLines1[] -
- customerLocale? anydata? -
- id? int -
- appId? anydata? -
- subtotalPrice? string -
- closedAt? anydata? -
- orderStatusUrl? string -
- deviceId? anydata? -
- test? boolean -
- totalShippingPriceSet? ReopenCloseOrderOrderTotalDiscountSet -
- subtotalPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- paymentGatewayNames? string[] -
- totalTax? string -
- processingMethod? string -
- shippingLines? ReopenCloseOrderOrderShippingLines[] -
- phone? string -
- userId? anydata? -
- noteAttributes? ReopenCloseOrderOrderNoteAttributes[] -
- name? string -
- cartToken? string -
- totalTaxSet? ReopenCloseOrderOrderPriceSet2 -
- landingSiteRef? string -
- discountCodes? ReopenCloseOrderOrderDiscountCodes[] -
- note? anydata? -
- paymentDetails? ReopenCloseOrderOrderPaymentDetails -
- orderNumber? int -
- discountApplications? ReopenCloseOrderOrderDiscountApplications[] -
- createdAt? string -
- totalLineItemsPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- taxesIncluded? boolean -
- buyerAcceptsMarketing? boolean -
- confirmed? boolean -
- totalWeight? int -
- contactEmail? string -
- refunds? ReopenCloseOrderOrderRefunds[] -
- totalDiscounts? string -
- fulfillments? ReopenCloseOrderOrderFulfillments[] -
- clientDetails? ReopenCloseOrderOrderClientDetails -
- referringSite? string -
- updatedAt? string -
- processedAt? string -
- currency? string -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- browserIp? string -
- email? string -
- sourceName? string -
- totalPriceSet? ReopenCloseOrderOrderTotalPriceSet -
- totalPrice? string -
- totalLineItemsPrice? string -
- token? string -
- cancelReason? anydata? -
- adminGraphqlApiId? string -
- financialStatus? string -
- gateway? string -
- customer? ReopenCloseOrderOrderCustomer -
shopify.admin: ReopenCloseOrderOrderBillingAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- latitude? decimal -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- name? string -
- company? anydata? -
- firstName? string -
- longitude? decimal -
shopify.admin: ReopenCloseOrderOrderClientDetails
Fields
- sessionHash? anydata? -
- acceptLanguage? anydata? -
- browserWidth? anydata? -
- browserHeight? anydata? -
- browserIp? string -
- userAgent? anydata? -
shopify.admin: ReopenCloseOrderOrderCustomer
Fields
- totalSpent? string -
- note? anydata? -
- lastOrderName? string -
- lastOrderId? int -
- taxExempt? boolean -
- createdAt? string -
- lastName? string -
- multipassIdentifier? anydata? -
- verifiedEmail? boolean -
- acceptsMarketingUpdatedAt? string -
- ordersCount? int -
- defaultAddress? ReopenCloseOrderOrderCustomerDefaultAddress -
- updatedAt? string -
- acceptsMarketing? boolean -
- phone? anydata? -
- adminGraphqlApiId? string -
- taxExemptions? anydata[] -
- currency? string -
- id? int -
- marketingOptInLevel? anydata? -
- state? string -
- firstName? string -
- email? string -
shopify.admin: ReopenCloseOrderOrderCustomerDefaultAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? anydata? -
- provinceCode? string -
- countryCode? string -
- default? boolean -
- province? string -
- phone? string -
- countryName? string -
- name? string -
- company? anydata? -
- id? int -
- customerId? int -
- firstName? anydata? -
shopify.admin: ReopenCloseOrderOrderDiscountApplications
Fields
- allocationMethod? string -
- valueType? string -
- code? string -
- targetType? string -
- targetSelection? string -
- 'type? string -
- value? string -
shopify.admin: ReopenCloseOrderOrderDiscountCodes
Fields
- amount? string -
- code? string -
- 'type? string -
shopify.admin: ReopenCloseOrderOrderFulfillments
Fields
- createdAt? string -
- lineItems? ReopenCloseOrderOrderLineItems[] -
- trackingCompany? string -
- trackingUrls? string[] -
- locationId? int -
- updatedAt? string -
- 'service? string -
- adminGraphqlApiId? string -
- name? string -
- trackingNumber? string -
- receipt? ReopenCloseOrderOrderReceipt -
- id? int -
- trackingNumbers? string[] -
- orderId? int -
- trackingUrl? string -
- shipmentStatus? anydata? -
- status? string -
shopify.admin: ReopenCloseOrderOrderLineItem
Fields
- variantTitle? string? -
- fulfillmentStatus? anydata? -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? ReopenCloseOrderOrderTaxLines[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? string -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderPriceSet -
- properties? anydata[] -
shopify.admin: ReopenCloseOrderOrderLineItems
Fields
- variantTitle? string? -
- fulfillmentStatus? anydata? -
- totalDiscount? string -
- giftCard? boolean -
- requiresShipping? boolean -
- totalDiscountSet? ReopenCloseOrderOrderTotalDiscountSet -
- title? string -
- productExists? boolean -
- variantId? int? -
- taxLines? ReopenCloseOrderOrderTaxLines[] -
- price? string -
- vendor? anydata? -
- productId? int? -
- id? int -
- grams? int -
- sku? string? -
- fulfillableQuantity? int -
- quantity? int -
- fulfillmentService? string -
- taxable? boolean -
- discountAllocations? anydata[] -
- variantInventoryManagement? string -
- adminGraphqlApiId? string -
- name? string -
- priceSet? ReopenCloseOrderOrderPriceSet -
- properties? ReopenCloseOrderOrderProperties[] -
shopify.admin: ReopenCloseOrderOrderNoteAttributes
Fields
- name? string -
- value? string -
shopify.admin: ReopenCloseOrderOrderPaymentDetails
Fields
- creditCardNumber? string -
- avsResultCode? anydata? -
- cvvResultCode? anydata? -
- creditCardBin? anydata? -
- creditCardCompany? string -
shopify.admin: ReopenCloseOrderOrderPriceSet
Fields
- shopMoney? ReopenCloseOrderOrderPriceSetPresentmentMoney -
- presentmentMoney? ReopenCloseOrderOrderPriceSetPresentmentMoney -
shopify.admin: ReopenCloseOrderOrderPriceSet1
Fields
- shopMoney? ReopenCloseOrderOrderPriceSet1PresentmentMoney -
- presentmentMoney? ReopenCloseOrderOrderPriceSet1PresentmentMoney -
shopify.admin: ReopenCloseOrderOrderPriceSet1PresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderPriceSet2
Fields
- shopMoney? ReopenCloseOrderOrderPriceSet2PresentmentMoney -
- presentmentMoney? ReopenCloseOrderOrderPriceSet2PresentmentMoney -
shopify.admin: ReopenCloseOrderOrderPriceSet2PresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderPriceSetPresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderProperties
Fields
- name? string -
- value? string -
shopify.admin: ReopenCloseOrderOrderReceipt
Fields
- testcase? boolean -
shopify.admin: ReopenCloseOrderOrderRefundLineItems
Fields
- lineItem? ReopenCloseOrderOrderLineItem -
- lineItemId? int -
- quantity? int -
- subtotal? decimal -
- totalTaxSet? ReopenCloseOrderOrderPriceSet1 -
- id? int -
- subtotalSet? ReopenCloseOrderOrderPriceSet -
- totalTax? decimal -
- locationId? int -
- restockType? string -
shopify.admin: ReopenCloseOrderOrderRefunds
Fields
- note? string? -
- refundLineItems? ReopenCloseOrderOrderRefundLineItems[] -
- userId? int -
- adminGraphqlApiId? string -
- orderAdjustments? anydata[] -
- createdAt? string -
- processedAt? string -
- restock? boolean -
- id? int -
- transactions? ReopenCloseOrderOrderTransactions[] -
- orderId? int -
shopify.admin: ReopenCloseOrderOrderShippingLines
Fields
- code? string -
- deliveryCategory? anydata? -
- 'source? string -
- discountAllocations? anydata[] -
- title? string -
- carrierIdentifier? anydata? -
- discountedPriceSet? ReopenCloseOrderOrderTotalDiscountSet -
- discountedPrice? string -
- taxLines? anydata[] -
- phone? anydata? -
- price? string -
- id? int -
- priceSet? ReopenCloseOrderOrderTotalDiscountSet -
- requestedFulfillmentServiceId? anydata? -
shopify.admin: ReopenCloseOrderOrderSubtotalPriceSet
Fields
- presentmentMoney? ReopenCloseOrderOrderSubtotalPriceSetPresentmentMoney -
shopify.admin: ReopenCloseOrderOrderSubtotalPriceSetPresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderTaxLines
Fields
- rate? decimal -
- price? string -
- priceSet? ReopenCloseOrderOrderPriceSet1 -
- title? string -
shopify.admin: ReopenCloseOrderOrderTaxLines1
Fields
- rate? decimal -
- price? string -
- priceSet? ReopenCloseOrderOrderPriceSet2 -
- title? string -
shopify.admin: ReopenCloseOrderOrderTotalDiscountSet
Fields
- presentmentMoney? ReopenCloseOrderOrderTotalDiscountSetPresentmentMoney -
shopify.admin: ReopenCloseOrderOrderTotalDiscountSetPresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderTotalDiscountsSet
Fields
- presentmentMoney? ReopenCloseOrderOrderTotalDiscountsSetPresentmentMoney -
shopify.admin: ReopenCloseOrderOrderTotalDiscountsSetPresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderTotalPriceSet
Fields
- shopMoney? ReopenCloseOrderOrderTotalPriceSetPresentmentMoney -
- presentmentMoney? ReopenCloseOrderOrderTotalPriceSetPresentmentMoney -
shopify.admin: ReopenCloseOrderOrderTotalPriceSetPresentmentMoney
Fields
- amount? string -
- currencyCode? string -
shopify.admin: ReopenCloseOrderOrderTransactions
Fields
- amount? string -
- deviceId? anydata? -
- test? boolean -
- kind? string -
- createdAt? string -
- message? anydata? -
- locationId? anydata? -
- userId? anydata? -
- parentId? int -
- adminGraphqlApiId? string -
- processedAt? string -
- currency? string -
- errorCode? anydata? -
- receipt? record {} -
- id? int -
- orderId? int -
- gateway? string -
- sourceName? string -
- status? string -
shopify.admin: ReportList
Fields
- reports? ReportListReports[] -
shopify.admin: ReportListReports
Fields
- updatedAt? string -
- name? string -
- id? int -
- category? string -
- shopifyQl? string -
shopify.admin: ReportResponse
Fields
- report? ReportResponseReport -
shopify.admin: ReportResponseReport
Fields
- updatedAt? string -
- name? string -
- id? int -
- category? string -
- shopifyQl? string -
shopify.admin: ReportsreportIdJsonBody
Fields
shopify.admin: ResourceFeedbackList
Fields
- resourceFeedback? ResourceFeedbackListResourceFeedback[] -
shopify.admin: ResourceFeedbackListResourceFeedback
Fields
- resourceUpdatedAt? anydata? -
- feedbackGeneratedAt? string -
- updatedAt? string -
- resourceType? string -
- createdAt? string -
- messages? string[] -
- resourceId? int -
- state? string -
shopify.admin: RestoreRemoveComment
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? string -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: RetrieveACountOfAllArticlesFromABlogQueries
Represents the Queries record for the operation: retrieveACountOfAllArticlesFromABlog
Fields
- createdAtMin? string - Count articles created after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Count articles created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMin? string - Count articles published after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMax? string - Count articles published before date (format: 2014-04-25T16:15:47-04:00).
- publishedStatus? string - Count articles with a given published status.(default: any)
shopify.admin: RetrieveACountOfAllScriptTagsQueries
Represents the Queries record for the operation: retrieveACountOfAllScriptTags
Fields
- src? string - Count only script tags with a given URL.
shopify.admin: RetrieveACountOfCheckoutsQueries
Represents the Queries record for the operation: retrieveACountOfCheckouts
Fields
- createdAtMin? string - Count checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Count checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Count checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Count checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)
- sinceId? string - Restrict results to after the specified ID.
- status? string - Count checkouts with a given status.(default: open)
shopify.admin: RetrieveACountOfCommentsQueries
Represents the Queries record for the operation: retrieveACountOfComments
Fields
- createdAtMin? string - Count comments created after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Count comments created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Count comments last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Count comments last updated after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMin? string - Count comments published after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMax? string - Count comments published before date (format: 2014-04-25T16:15:47-04:00).
- publishedStatus? string - Retrieve a count of comments with a given published status.(default: any)
- status? string - Retrieve a count of comments with a given status.
shopify.admin: RetrieveACountOfCustomCollectionsQueries
Represents the Queries record for the operation: retrieveACountOfCustomCollections
Fields
- updatedAtMax? string - Count custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Count custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).
- productId? string - Count custom collections that include a given product.
- publishedAtMin? string - Count custom collections published after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMax? string - Count custom collections published before date (format: 2014-04-25T16:15:47-04:00).
- publishedStatus? string - Count custom collections with a given published status.(default: any)
- title? string - Count custom collections with given title.
shopify.admin: RetrieveACountOfDiscountCodesForAShopQueries
Represents the Queries record for the operation: retrieveACountOfDiscountCodesForAShop
Fields
- timesUsedMax? string - Show discount codes used greater than or equal to this value
- timesUsedMin? string - Show discount codes used less than or equal to this value
- timesUsed? string - Show discount codes with times used
shopify.admin: RetrieveACountOfEventsQueries
Represents the Queries record for the operation: retrieveACountOfEvents
Fields
- createdAtMin? string - Count only events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Count only events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)
shopify.admin: RetrieveACountOfFulfillmentsAssociatedWithASpecificOrderQueries
Represents the Queries record for the operation: retrieveACountOfFulfillmentsAssociatedWithASpecificOrder
Fields
- createdAtMin? string - Count fulfillments created after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Count fulfillments created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Count fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Count fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).
shopify.admin: RetrieveACountOfGiftCardsQueries
Represents the Queries record for the operation: retrieveACountOfGiftCards
Fields
- status? string - Count gift cards with a given status. Valid values:
shopify.admin: RetrieveACountOfProductsQueries
Represents the Queries record for the operation: retrieveACountOfProducts
Fields
- collectionId? string - Filter results by collection ID.
- createdAtMin? string - Show products created after date. (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Show products created before date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)
- productType? string - Filter results by product type.
- updatedAtMin? string - Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)
- vendor? string - Filter results by product vendor.
- publishedAtMin? string - Show products published after date. (format: 2014-04-25T16:15:47-04:00)
- publishedAtMax? string - Show products published before date. (format: 2014-04-25T16:15:47-04:00)
- publishedStatus? string - Return products by their published status(default: any)
shopify.admin: RetrieveACountOfSmartCollectionsQueries
Represents the Queries record for the operation: retrieveACountOfSmartCollections
Fields
- updatedAtMax? string - Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)
- productId? string - Show smart collections that include the specified product.
- publishedAtMin? string - Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)
- publishedAtMax? string - Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)
- publishedStatus? string - Filter results based on the published status of smart collections.(default: any)
- title? string - Show smart collections with the specified title.
shopify.admin: RetrieveACountOfUrlRedirectsQueries
Represents the Queries record for the operation: retrieveACountOfUrlRedirects
Fields
- path? string - Count redirects with given path.
- target? string - Count redirects with given target.
shopify.admin: RetrieveADetailedListForInventoryItemsByIdsQueries
Represents the Queries record for the operation: retrieveADetailedListForInventoryItemsByIds
Fields
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- ids? string - Show only inventory items specified by a comma-separated list of IDs.(maximum: 100)
shopify.admin: RetrieveAListOfAbandonedCheckoutsQueries
Represents the Queries record for the operation: retrieveAListOfAbandonedCheckouts
Fields
- createdAtMin? string - Show checkouts created after the specified date. (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Show checkouts created before the specified date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show checkouts last updated before the specified date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show checkouts last updated after the specified date. (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- sinceId? string - Restrict results to after the specified ID.
- status? string - Show only checkouts with a given status.(default: open)
shopify.admin: RetrieveAListOfAllArticlesFromABlogQueries
Represents the Queries record for the operation: retrieveAListOfAllArticlesFromABlog
Fields
- createdAtMin? string - Show articles created after date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Show articles last updated before date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMin? string - Show articles published after date (format: 2014-04-25T16:15:47-04:00).
- 'handle? string - Retrieve an article with a specific handle.
- publishedStatus? string - Retrieve results based on their published status.(default: any)
- sinceId? string - Restrict results to after the specified ID.
- createdAtMax? string - Show articles created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Show articles last updated after date (format: 2014-04-25T16:15:47-04:00).
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- publishedAtMax? string - Show articles published before date (format: 2014-04-25T16:15:47-04:00).
- tag? string - Filter articles with a specific tag.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfAllArticleTagsFromASpecificBlogQueries
Represents the Queries record for the operation: retrieveAListOfAllArticleTagsFromASpecificBlog
Fields
- 'limit? string - The maximum number of tags to retrieve
- popular? string - A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag
shopify.admin: RetrieveAListOfAllArticleTagsQueries
Represents the Queries record for the operation: retrieveAListOfAllArticleTags
Fields
- 'limit? string - The maximum number of tags to retrieve.
- popular? string - A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag.
shopify.admin: RetrieveAListOfAllBlogsQueries
Represents the Queries record for the operation: retrieveAListOfAllBlogs
Fields
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- 'handle? string - Filter by blog handle
- sinceId? string - Restrict results to after the specified ID
- fields? string - comma-separated list of fields to include in the response
shopify.admin: RetrieveAListOfAllMarketingEventsQueries
Represents the Queries record for the operation: retrieveAListOfAllMarketingEvents
Fields
- offset? string - The number of marketing events to skip.
- 'limit? string - The amount of results to return.(default: 50)(maximum: 250)
shopify.admin: RetrieveAListOfAllScriptTagsQueries
Represents the Queries record for the operation: retrieveAListOfAllScriptTags
Fields
- createdAtMin? string - Show script tags created after this date. (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Show script tags created before this date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show script tags last updated before this date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show script tags last updated after this date. (format: 2014-04-25T16:15:47-04:00)
- src? string - Show script tags with this URL.
- 'limit? string - The number of results to return.(default: 50)(maximum: 250)
- sinceId? string - Restrict results to after the specified ID.
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveAListOfApplicationChargesQueries
Represents the Queries record for the operation: retrieveAListOfApplicationCharges
Fields
- fields? string - A comma-separated list of fields to include in the response
- sinceId? string - Restrict results to after the specified ID
shopify.admin: RetrieveAListOfAssetsForAThemeQueries
Represents the Queries record for the operation: retrieveAListOfAssetsForATheme
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names
shopify.admin: RetrieveAListOfCollectsQueries
Represents the Queries record for the operation: retrieveAListOfCollects
Fields
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- sinceId? string - Restrict results to after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfCommentsQueries
Represents the Queries record for the operation: retrieveAListOfComments
Fields
- createdAtMin? string - Show comments created after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Show comments created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Show comments last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Show comments last updated after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMin? string - Show comments published after date (format: 2014-04-25T16:15:47-04:00).
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- publishedAtMax? string - Show comments published before date (format: 2014-04-25T16:15:47-04:00).
- publishedStatus? string - Filter results by their published status.(default: any)
- sinceId? string - Restrict results to after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- status? string - Filter results by their status.
shopify.admin: RetrieveAListOfCustomCollectionsQueries
Represents the Queries record for the operation: retrieveAListOfCustomCollections
Fields
- updatedAtMax? string - Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).
- productId? string - Show custom collections that include a given product.
- publishedAtMin? string - Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- ids? string - Show only collections specified by a comma-separated list of IDs.
- publishedAtMax? string - Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).
- 'handle? string - Filter by custom collection handle.
- publishedStatus? string - Show custom collectsion with a given published status.(default: any)
- sinceId? string - Restrict results to after the specified ID.
- title? string - Show custom collections with a given title.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfCustomersQueries
Represents the Queries record for the operation: retrieveAListOfCustomers
Fields
- createdAtMin? string - Show customers created after a specified date.
(format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Show customers created before a specified date.
(format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show customers last updated before a specified date.
(format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show customers last updated after a specified date.
(format: 2014-04-25T16:15:47-04:00)
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- ids? string - Restrict results to customers specified by a comma-separated list of IDs.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- sinceId? string - Restrict results to those after the specified ID.
shopify.admin: RetrieveAListOfDraftOrdersQueries
Represents the Queries record for the operation: retrieveAListOfDraftOrders
Fields
- updatedAtMax? string - Show orders last updated before date (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show orders last updated after date (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - Amount of results(default: 50)(maximum: 250)
- ids? string - Filter by list of IDs
- fields? string - A comma-separated list of fields to include in the response
- sinceId? string - Restrict results to after the specified ID
- status? string -
shopify.admin: RetrieveAListOfEventsQueries
Represents the Queries record for the operation: retrieveAListOfEvents
Fields
- createdAtMin? string - Show events created at or after this date and time. (format: 2014-04-25T16:15:47-04:00)
- filter? string - Show events specified in this filter.
- createdAtMax? string - Show events created at or before this date and time. (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - The number of results to show.(default: 50)(maximum: 250)
- verb? string - Show events of a certain type.
- sinceId? string - Show only results after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfGiftCardsQueries
Represents the Queries record for the operation: retrieveAListOfGiftCards
Fields
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- sinceId? string - Restrict results to after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- status? string - Retrieve gift cards with a given status. Valid values: enabled, disabled
shopify.admin: RetrieveAListOfInventoryLevelsQueries
Represents the Queries record for the operation: retrieveAListOfInventoryLevels
Fields
- updatedAtMin? string - Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).
- inventoryItemIds? string - A comma-separated list of inventory item IDs.(maximum: 50)
- locationIds? string - A comma-separated list of location IDs. To find the ID of a location, use the Location resource.(maximum: 50)
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
shopify.admin: RetrieveAListOfMetafieldsFromTheResourceSEndpointQueries
Represents the Queries record for the operation: retrieveAListOfMetafieldsFromTheResourceSEndpoint
Fields
- createdAtMin? string - Show metafields created after date (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Show metafields created before date (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show metafields last updated before date (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show metafields last updated after date (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - Amount of results(default: 50)(maximum: 250)
- namespace? string - Show metafields with given namespace
- fields? string - comma-separated list of fields to include in the response
- sinceId? string - Restrict results to after the specified ID
- 'type? string - The type of data that the metafield stores in the
valuefield. Refer to the list of supported types
- 'key? string - Show metafields with given key
shopify.admin: RetrieveAListOfOrdersQueries
Represents the Queries record for the operation: retrieveAListOfOrders
Fields
- createdAtMin? string - Show orders created at or after date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00).
- fulfillmentStatus? string - Filter orders by their fulfillment status.(default: any)
- sinceId? string - Show orders after the specified ID.
- processedAtMax? string - Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00).
- processedAtMin? string - Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Show orders created at or before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00).
- financialStatus? string - Filter orders by their financial status.(default: any)
- name? string -
- 'limit? string - The maximum number of results to show on a page.(default: 50)(maximum: 250)
- ids? string - Retrieve only orders specified by a comma-separated list of order IDs.
- attributionAppId? string - Show orders attributed to a certain app, specified by the app ID. Set as
currentto show orders for the app currently consuming the API.
- fields? string - Retrieve only certain fields, specified by a comma-separated list of fields names.
- status? string - Filter orders by their status.(default: open)
shopify.admin: RetrieveAListOfPagesQueries
Represents the Queries record for the operation: retrieveAListOfPages
Fields
- createdAtMin? string - Show pages created after date (format: 2008-12-31).
- createdAtMax? string - Show pages created before date (format: 2008-12-31).
- updatedAtMax? string - Show pages last updated before date (format: 2008-12-31).
- updatedAtMin? string - Show pages last updated after date (format: 2008-12-31).
- publishedAtMin? string - Show pages published after date (format: 2014-04-25T16:15:47-04:00).
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- publishedAtMax? string - Show pages published before date (format: 2014-04-25T16:15:47-04:00).
- 'handle? string - Retrieve a page with a given handle.
- publishedStatus? string - Restrict results to pages with a given published status:(default: any)
- sinceId? string - Restrict results to after the specified ID.
- title? string - Retrieve pages with a given title.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfPriceRulesQueries
Represents the Queries record for the operation: retrieveAListOfPriceRules
Fields
- createdAtMin? string - Show price rules created after date (format 2017-03-25T16:15:47-04:00).
- startsAtMin? string - Show price rules starting after date (format 2017-03-25T16:15:47-04:00).
- createdAtMax? string - Show price rules created before date (format 2017-03-25T16:15:47-04:00).
- updatedAtMax? string - Show price rules last updated before date (format 2017-03-25T16:15:47-04:00).
- startsAtMax? string - Show price rules starting before date (format 2017-03-25T16:15:47-04:00).
- updatedAtMin? string - Show price rules last updated after date (format 2017-03-25T16:15:47-04:00).
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- timesUsed? string - Show price rules with times used.
- sinceId? string - Restrict results to after the specified ID.
- endsAtMin? string - Show price rules ending after date (format 2017-03-25T16:15:47-04:00).
- endsAtMax? string - Show price rules ending before date (format 2017-03-25T16:15:47-04:00).
shopify.admin: RetrieveAListOfProductsBelongingToACollectionQueries
Represents the Queries record for the operation: retrieveAListOfProductsBelongingToACollection
Fields
- 'limit? string - The number of products to retrieve.(default: 50)(maximum: 250)
shopify.admin: RetrieveAListOfProductsQueries
Represents the Queries record for the operation: retrieveAListOfProducts
Fields
- createdAtMin? string - Show products created after date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)
- publishedAtMin? string - Show products published after date. (format: 2014-04-25T16:15:47-04:00)
- 'handle? string - Filter results by product handle.
- publishedStatus? string - Return products by their published status(default: any)
- sinceId? string - Restrict results to after the specified ID.
- title? string - Filter results by product title.
- collectionId? string - Filter results by product collection ID.
- createdAtMax? string - Show products created before date. (format: 2014-04-25T16:15:47-04:00)
- productType? string - Filter results by product type.
- updatedAtMin? string - Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)
- vendor? string - Filter results by product vendor.
- 'limit? string - Return up to this many results per page.(default: 50)(maximum: 250)
- ids? string - Return only products specified by a comma-separated list of product IDs.
- publishedAtMax? string - Show products published before date. (format: 2014-04-25T16:15:47-04:00)
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfProductVariantsQueries
Represents the Queries record for the operation: retrieveAListOfProductVariants
Fields
- 'limit? string - Return up to this many results per page(default: 50)(maximum: 250)
- sinceId? string - Restrict results to after the specified ID
- fields? string - A comma-separated list of fields to include in the response
shopify.admin: RetrieveAListOfProvincesForACountryQueries
Represents the Queries record for the operation: retrieveAListOfProvincesForACountry
Fields
- sinceId? string - Restrict results to after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of fields names.
shopify.admin: RetrieveAListOfRecurringApplicationChargesQueries
Represents the Queries record for the operation: retrieveAListOfRecurringApplicationCharges
Fields
- fields? string - A comma-separated list of fields to include in the response.
- sinceId? string - Restrict results to after the specified ID.
shopify.admin: RetrieveAListOfRefundsForAnOrderQueries
Represents the Queries record for the operation: retrieveAListOfRefundsForAnOrder
Fields
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- inShopCurrency? string - Show amounts in the shop currency for the underlying transaction.(default: false)
shopify.admin: RetrieveAListOfReportsQueries
Represents the Queries record for the operation: retrieveAListOfReports
Fields
- updatedAtMax? string - Show reports last updated before date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show reports last updated after date. (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - The amount of results to return
- ids? string - A comma-separated list of report IDs
- fields? string - A comma-separated list of fields to include in the response
- sinceId? string - Restrict results to after the specified ID
shopify.admin: RetrieveAListOfSmartCollectionsQueries
Represents the Queries record for the operation: retrieveAListOfSmartCollections
Fields
- updatedAtMax? string - Show smart collections last updated before this date. (format: 2014-04-25T16:15:47-04:00)
- updatedAtMin? string - Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00)
- productId? string - Show smart collections that includes the specified product.
- publishedAtMin? string - Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - The number of results to show.(default: 50)(maximum: 250)
- ids? string - Show only the smart collections specified by a comma-separated list of IDs.
- publishedAtMax? string - Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00)
- 'handle? string - Filter results by smart collection handle.
- publishedStatus? string - Filter results based on the published status of smart collections.(default: any)
- sinceId? string - Restrict results to after the specified ID.
- title? string - Show smart collections with the specified title.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfTenderTransactionsQueries
Represents the Queries record for the operation: retrieveAListOfTenderTransactions
Fields
- processedAtMin? string - Show tender transactions processed_at or after the specified date.
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- processedAt? string - Show tender transactions processed at the specified date.
- sinceId? string - Retrieve only transactions after the specified ID.
- processedAtMax? string - Show tender transactions processed_at or before the specified date.
- 'order? string - Show tender transactions ordered by processed_at in ascending or descending order.
shopify.admin: RetrieveAListOfThemesQueries
Represents the Queries record for the operation: retrieveAListOfThemes
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveAListOfTransactionsQueries
Represents the Queries record for the operation: retrieveAListOfTransactions
Fields
- sinceId? string - Retrieve only transactions after the specified ID.
- fields? string - Show only certain fields, specifed by a comma-separated list of fields names.
- inShopCurrency? string - Show amounts in the shop currency.(default: false)
shopify.admin: RetrieveAListOfUrlRedirectsQueries
Represents the Queries record for the operation: retrieveAListOfUrlRedirects
Fields
- path? string - Show redirects with a given path.
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- sinceId? string - Restrict results to after the specified ID.
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- target? string - Show redirects with a given target.
shopify.admin: RetrieveAListOfUsageChargesQueries
Represents the Queries record for the operation: retrieveAListOfUsageCharges
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveAListOfWebhooksQueries
Represents the Queries record for the operation: retrieveAListOfWebhooks
Fields
- createdAtMin? string - Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).
- address? string - Retrieve webhook subscriptions that send the POST request to this URI.
- updatedAtMin? string - Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).
- 'limit? string - Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.(default: 50)(maximum: 250)
- topic? string - Show webhook subscriptions with a given topic. For a list of valid values, refer to the
topicproperty.>
- fields? string - Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.
- sinceId? string - Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.
shopify.admin: RetrieveAllApplicationCreditsQueries
Represents the Queries record for the operation: retrieveAllApplicationCredits
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveAnApplicationChargeQueries
Represents the Queries record for the operation: retrieveAnApplicationCharge
Fields
- fields? string - A comma-separated list of fields to include in the response
shopify.admin: RetrieveAnOrderCountQueries
Represents the Queries record for the operation: retrieveAnOrderCount
Fields
- createdAtMin? string - Count orders created after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Count orders created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Count orders last updated before date (format: 2014-04-25T16:15:47-04:00).
- fulfillmentStatus? string - Filter orders by their fulfillment status.(default: any)
- updatedAtMin? string - Count orders last updated after date (format: 2014-04-25T16:15:47-04:00).
- financialStatus? string - Count orders of a given financial status.(default: any)
- status? string - Count orders of a given status.(default: open)
shopify.admin: RetrieveAPageCountQueries
Represents the Queries record for the operation: retrieveAPageCount
Fields
- createdAtMin? string - Count pages created after date (format: 2008-12-31).
- createdAtMax? string - Count pages created before date (format: 2008-12-31).
- updatedAtMax? string - Count pages last updated before date (format: 2008-12-31).
- updatedAtMin? string - Count pages last updated after date (format: 2008-12-31).
- publishedAtMin? string - Show pages published after date (format: 2014-04-25T16:15:47-04:00).
- publishedAtMax? string - Show pages published before date (format: 2014-04-25T16:15:47-04:00).
- publishedStatus? string - Count pages with a given published status:(default: any)
- title? string - Count pages with a given title.
shopify.admin: RetrieveASingleApplicationCreditQueries
Represents the Queries record for the operation: retrieveASingleApplicationCredit
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveASingleCharge1Queries
Represents the Queries record for the operation: retrieveASingleCharge1
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveASingleChargeQueries
Represents the Queries record for the operation: retrieveASingleCharge
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveASingleCollectionQueries
Represents the Queries record for the operation: retrieveASingleCollection
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleCommentByItsIdQueries
Represents the Queries record for the operation: retrieveASingleCommentByItsId
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleCustomCollectionQueries
Represents the Queries record for the operation: retrieveASingleCustomCollection
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleCustomerQueries
Represents the Queries record for the operation: retrieveASingleCustomer
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleEventQueries
Represents the Queries record for the operation: retrieveASingleEvent
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleGiftCardQueries
Represents the Queries record for the operation: retrieveASingleGiftCard
Fields
- status? string - Count gift cards with a given status. Valid values: enabled, disabled
shopify.admin: RetrieveASinglePageByItsIdQueries
Represents the Queries record for the operation: retrieveASinglePageByItsId
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleProductQueries
Represents the Queries record for the operation: retrieveASingleProduct
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveASingleProvinceForACountryQueries
Represents the Queries record for the operation: retrieveASingleProvinceForACountry
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleRedirectQueries
Represents the Queries record for the operation: retrieveASingleRedirect
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleReportQueries
Represents the Queries record for the operation: retrieveASingleReport
Fields
- fields? string - A comma-separated list of fields to include in the response
shopify.admin: RetrieveASingleScriptTagQueries
Represents the Queries record for the operation: retrieveASingleScriptTag
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: RetrieveASingleSmartCollectionQueries
Represents the Queries record for the operation: retrieveASingleSmartCollection
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASingleThemeQueries
Represents the Queries record for the operation: retrieveASingleTheme
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASpecificCollectByItsIdQueries
Represents the Queries record for the operation: retrieveASpecificCollectByItsId
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASpecificCountyQueries
Represents the Queries record for the operation: retrieveASpecificCounty
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
shopify.admin: RetrieveASpecificMetafieldQueries
Represents the Queries record for the operation: retrieveASpecificMetafield
Fields
- fields? string - comma-separated list of fields to include in the response
shopify.admin: RetrieveASpecificRefundQueries
Represents the Queries record for the operation: retrieveASpecificRefund
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- inShopCurrency? string - Show amounts in the shop currency for the underlying transaction.(default: false)
shopify.admin: RetrieveASpecificTransactionQueries
Represents the Queries record for the operation: retrieveASpecificTransaction
Fields
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- inShopCurrency? string - Show amounts in the shop currency.(default: false)
shopify.admin: RetrieveCollectionListingsThatArePublishedToYourAppQueries
Represents the Queries record for the operation: retrieveCollectionListingsThatArePublishedToYourApp
Fields
- 'limit? string - Amount of results(default: 50)(maximum: 1000)
shopify.admin: RetrieveFulfillmentsAssociatedWithAnOrderQueries
Represents the Queries record for the operation: retrieveFulfillmentsAssociatedWithAnOrder
Fields
- createdAtMin? string - Show fulfillments created after date (format: 2014-04-25T16:15:47-04:00).
- createdAtMax? string - Show fulfillments created before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMax? string - Show fulfillments last updated before date (format: 2014-04-25T16:15:47-04:00).
- updatedAtMin? string - Show fulfillments last updated after date (format: 2014-04-25T16:15:47-04:00).
- 'limit? string - Limit the amount of results.(default: 50)(maximum: 250)
- fields? string - A comma-separated list of fields to include in the response.
- sinceId? string - Restrict results to after the specified ID.
shopify.admin: RetrieveProductIdsThatArePublishedToACollectionIdQueries
Represents the Queries record for the operation: retrieveProductIdsThatArePublishedToACollectionId
Fields
- 'limit? string - Amount of results(default: 50)(maximum: 1000)
shopify.admin: RetrieveProductIdsThatArePublishedToYourAppQueries
Represents the Queries record for the operation: retrieveProductIdsThatArePublishedToYourApp
Fields
- 'limit? string - Amount of results(default: 50)(maximum: 1000)
shopify.admin: RetrieveProductListingsThatArePublishedToYourAppQueries
Represents the Queries record for the operation: retrieveProductListingsThatArePublishedToYourApp
Fields
- collectionId? string - Filter by products belonging to a particular collection
- productIds? string - A comma-separated list of product ids
- updatedAtMin? string - Filter by products last updated after a certain date and time (formatted in ISO 8601)
- 'limit? string - Amount of results(default: 50)(maximum: 1000)
- 'handle? string - Filter by product handle
- page? string - Page to show(default: 1)
shopify.admin: RetrievesAListOfFulfillmentOrdersAssignedToTheShopLocationsThatAreOwnedByTheAppQueries
Represents the Queries record for the operation: retrievesAListOfFulfillmentOrdersAssignedToTheShopLocationsThatAreOwnedByTheApp
Fields
- assignmentStatus? string - The assignment status of the fulfillment orders that should be returned. If assignment_status parameter isn't provided, then the query will return all assigned fulfillment orders, except those with the CLOSED status
- locationIds? string - he IDs of the assigned locations of the fulfillment orders that should be returned. If the location_ids parameter isn't provided, then all fulfillment orders assigned to the shop locations that are managed by the app will be returned
shopify.admin: RetrieveTheShopSConfigurationQueries
Represents the Queries record for the operation: retrieveTheShopSConfiguration
Fields
- fields? string - A comma-separated list of fields to include in the response.
shopify.admin: ReturnAListOfAllBalanceTransactionsQueries
Represents the Queries record for the operation: returnAListOfAllBalanceTransactions
Fields
- payoutId? string - Filter response to transactions paid out in the specified payout.
- test? string - Filter response to transactions placed in test mode.
- payoutStatus? string - Filter response to transactions with the specified payout status
- lastId? string - Filter response to transactions exclusively before the specified ID
- sinceId? string - Filter response to transactions exclusively after the specified ID.
shopify.admin: ReturnAListOfAllDisputesQueries
Represents the Queries record for the operation: returnAListOfAllDisputes
Fields
- lastId? string - Return only disputes before the specified ID.
- sinceId? string - Return only disputes after the specified ID.
- status? string - Return only disputes with the specified status.
shopify.admin: ReturnAListOfAllPayoutsQueries
Represents the Queries record for the operation: returnAListOfAllPayouts
Fields
- date? string - Filter response to payouts on the specified date.
- dateMin? string - Filter response to payouts inclusively after the specified date.
- dateMax? string - Filter response to payouts inclusively before the specified date.
- lastId? string - Filter response to payouts exclusively before the specified ID
- sinceId? string - Filter response to payouts exclusively after the specified ID.
- status? string - Filter response to payouts with the specified status
shopify.admin: ScriptTagResponse
Fields
- scriptTag? ScriptTagResponseScriptTag -
shopify.admin: ScriptTagResponseScriptTag
Fields
- updatedAt? string -
- src? string -
- createdAt? string -
- id? int -
- displayScope? string -
- event? string -
shopify.admin: ScriptTagsList
Fields
- scriptTags? SingleScriptTagScriptTag[] -
shopify.admin: ScriptTagsscriptTagIdJsonBody
Fields
- scriptTag? AdminapiapiVersionscriptTagsscriptTagIdJsonScriptTag -
shopify.admin: SearchForCustomersThatMatchASuppliedQueryQueries
Represents the Queries record for the operation: searchForCustomersThatMatchASuppliedQuery
Fields
- query? string - Text to search for in the shop's customer data.
- 'limit? string - The maximum number of results to show.(default: 50)(maximum: 250)
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- 'order? string - Set the field and direction by which to order results.(default: last_order_date DESC)
shopify.admin: SearchForGiftCardsQueries
Represents the Queries record for the operation: searchForGiftCards
Fields
- createdAtMin? string - Show gift cards created at or after date
- createdAtMax? string - Show gift cards created at or before date
- updatedAtMax? string - Show gift cards last updated at or before date
- updatedAtMin? string - Show gift cards last updated at or after date
- query? string - The text to search for.
- 'limit? string - The maximum number of results to retrieve.(default: 50)(maximum: 250)
- fields? string - Show only certain fields, specified by a comma-separated list of field names.
- 'order? string - The field and direction to order results by.(default: disabled_at DESC)
shopify.admin: ShippingRateResponse
Fields
- checkout? ShippingRateResponseCheckout -
shopify.admin: ShippingRateResponseCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? anydata[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? SinglePaymentResponsePaymentCheckoutShippingRate -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? SinglePaymentResponsePaymentCheckoutShippingLine? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? anydata[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? anydata? -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: ShippingRates
Fields
- shippingRates? anydata[] -
shopify.admin: ShippingZonesList
Fields
- shippingZones? DeliveryZone[] -
shopify.admin: ShopConfigurations
Fields
- shop? ShopConfigurationsShop -
shopify.admin: ShopConfigurationsShop
Fields
- country? string -
- hasGiftCards? boolean -
- multiLocationEnabled? boolean -
- 'source? anydata? -
- moneyWithCurrencyInEmailsFormat? string -
- provinceCode? string -
- planDisplayName? string -
- province? string -
- eligibleForPayments? boolean -
- id? int -
- longitude? decimal -
- hasDiscounts? boolean -
- zip? string -
- forceSsl? boolean -
- passwordEnabled? boolean -
- eligibleForCardReaderGiveaway? boolean -
- ianaTimezone? string -
- enabledPresentmentCurrencies? string[] -
- planName? string -
- requiresExtraPaymentsAgreement? boolean -
- countryCode? string -
- weightUnit? string -
- phone? string -
- customerEmail? string -
- domain? string -
- countyTaxes? boolean -
- moneyWithCurrencyFormat? string -
- name? string -
- moneyInEmailsFormat? string -
- finances? boolean -
- shopOwner? string -
- preLaunchEnabled? boolean -
- city? string -
- timezone? string -
- latitude? decimal -
- createdAt? string -
- checkoutApiSupported? boolean -
- taxesIncluded? anydata? -
- setupRequired? boolean -
- moneyFormat? string -
- updatedAt? string -
- countryName? string -
- currency? string -
- email? string -
- primaryLocationId? int -
- googleAppsLoginEnabled? anydata? -
- address2? string -
- address1? string -
- primaryLocale? string -
- hasStorefront? boolean -
- taxShipping? anydata? -
- googleAppsDomain? anydata? -
- myshopifyDomain? string -
shopify.admin: ShopPoliciesList
Fields
- policies? ShopPoliciesListPolicies[] -
shopify.admin: ShopPoliciesListPolicies
Fields
- updatedAt? string -
- createdAt? string -
- 'handle? string -
- body? string -
- title? string -
- url? string -
shopify.admin: ShopRetrieveAListOfMetafieldsFromTheResourceSEndpointQueries
Represents the Queries record for the operation: shopRetrieveAListOfMetafieldsFromTheResourceSEndpoint
Fields
- createdAtMin? string - Show metafields created after date (format: 2014-04-25T16:15:47-04:00)
- createdAtMax? string - Show metafields created before date (format: 2014-04-25T16:15:47-04:00)
- updatedAtMax? string - Show metafields last updated before date (format: 2014-04-25T16:15:47-04:00)
- metafieldOwnerId? string - Filter by the resource ID on which the metafield is attached to
- updatedAtMin? string - Show metafields last updated after date (format: 2014-04-25T16:15:47-04:00)
- 'limit? string - Amount of results(default: 50)(maximum: 250)
- namespace? string - Show metafields with given namespace
- fields? string - comma-separated list of fields to include in the response
- sinceId? string - Restrict results to after the specified ID
- 'type? string - The type of data that the metafield stores in the
valuefield. Refer to the list of supported types
- 'key? string - Show metafields with given key
- metafieldOwnerResource? string - Filter by the resource name on which the metafield is attached to
shopify.admin: ShopRetrieveASpecificMetafieldQueries
Represents the Queries record for the operation: shopRetrieveASpecificMetafield
Fields
- fields? string - comma-separated list of fields to include in the response
shopify.admin: SingleArticle
Fields
- article? SingleArticleArticle -
shopify.admin: SingleArticleArticle
Fields
- image? SingleArticleArticleImage -
- blogId? int -
- bodyHtml? string -
- createdAt? string -
- 'handle? string -
- title? string -
- templateSuffix? anydata? -
- updatedAt? string -
- userId? int -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string -
- summaryHtml? anydata? -
shopify.admin: SingleArticleArticleImage
Fields
- src? string -
- alt? string -
- width? int -
- createdAt? string -
- height? int -
shopify.admin: SingleBlog
Fields
- blog? SingleBlogBlog -
shopify.admin: SingleBlogBlog
Fields
- feedburner? anydata? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- feedburnerLocation? anydata? -
- createdAt? string -
- 'handle? string -
- id? int -
- title? string -
- commentable? string -
shopify.admin: SingleCarrierService
Fields
- carrierService? SingleCarrierServiceCarrierService -
shopify.admin: SingleCarrierServiceCarrierService
Fields
- callbackUrl? string -
- carrierServiceType? string -
- adminGraphqlApiId? string -
- format? string -
- name? string -
- serviceDiscovery? boolean -
- active? boolean -
- id? int -
shopify.admin: SingleCharge
Fields
- recurringApplicationCharge? SingleChargeRecurringApplicationCharge -
shopify.admin: SingleChargeRecurringApplicationCharge
Fields
- apiClientId? int -
- test? anydata? -
- createdAt? string -
- cancelledOn? anydata? -
- trialDays? int -
- decoratedReturnUrl? string -
- updatedAt? string -
- confirmationUrl? string -
- price? string -
- trialEndsOn? anydata? -
- name? string -
- returnUrl? string -
- billingOn? string -
- currency? string -
- id? int -
- activatedOn? anydata? -
- status? string -
shopify.admin: SingleCollection
Fields
- collection? SingleCollectionCollection -
shopify.admin: SingleCollectionCollection
Fields
- image? SingleCollectionCollectionImage -
- bodyHtml? string -
- productsCount? int -
- 'handle? string -
- title? string -
- collectionType? string -
- publishedScope? string -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string -
- sortOrder? string -
shopify.admin: SingleCollectionCollectionImage
Fields
- src? string -
- alt? string -
- width? int -
- createdAt? string -
- height? int -
shopify.admin: SingleCommentResponse
Fields
- comment? SingleCommentResponseComment -
shopify.admin: SingleCommentResponseComment
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? anydata? -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: SingleCustomCollection
Fields
- customCollection? SingleCustomCollectionCustomCollection -
shopify.admin: SingleCustomCollectionCustomCollection
Fields
- publishedScope? string -
- bodyHtml? string? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- productsCount? int -
- 'handle? string -
- id? int -
- publishedAt? string -
- title? string -
- sortOrder? string -
shopify.admin: SingleCustomerAddress
Fields
- customerAddress? ReopenCloseOrderOrderCustomerDefaultAddress -
shopify.admin: SingleDiscountCode
Fields
- discountCode? DiscountCodesDiscountCodes -
shopify.admin: SingleDispute
Fields
- dispute? SingleDisputeDispute -
shopify.admin: SingleDisputeDispute
Fields
- reason? string -
- amount? string -
- evidenceDueBy? string -
- finalizedOn? anydata? -
- currency? string -
- id? int -
- initiatedAt? string -
- 'type? string -
- networkReasonCode? string -
- orderId? int -
- evidenceSentOn? anydata? -
- status? string -
shopify.admin: SingleDraftOrder
Fields
- draftOrder? SingleDraftOrderDraftOrder -
shopify.admin: SingleDraftOrderDraftOrder
Fields
- note? string? -
- appliedDiscount? CompleteDraftOrderDraftOrderAppliedDiscount? -
- createdAt? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ModifyDraftOrderDraftOrderLineItems[] -
- taxesIncluded? boolean -
- taxLines? anydata[] -
- updatedAt? string -
- currency? string -
- id? int -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- email? string -
- subtotalPrice? string -
- totalPrice? string -
- taxExempt? boolean -
- invoiceSentAt? anydata? -
- totalTax? string -
- completedAt? anydata? -
- adminGraphqlApiId? string -
- noteAttributes? anydata[] -
- name? string -
- shippingLine? ModifyDraftOrderDraftOrderShippingLine? -
- orderId? anydata? -
- invoiceUrl? string -
- customer? AbandonedCheckoutsCustomer -
- status? string -
shopify.admin: SingleEvent
Fields
- event? SingleEventEvent -
shopify.admin: SingleEventEvent
Fields
- subjectId? int -
- path? string -
- subjectType? string -
- verb? string -
- createdAt? string -
- description? string -
- arguments? string[] -
- id? int -
- body? anydata? -
- message? string -
shopify.admin: SingleFulfillment
Fields
- fulfillment? SingleFulfillmentFulfillment -
shopify.admin: SingleFulfillmentFulfillment
Fields
- createdAt? string -
- lineItems? ReopenCloseOrderOrderLineItems[] -
- trackingCompany? string -
- trackingUrls? string[] -
- locationId? int -
- updatedAt? string -
- 'service? string -
- adminGraphqlApiId? string -
- name? string -
- trackingNumber? string -
- receipt? ReopenCloseOrderOrderReceipt -
- id? int -
- trackingNumbers? string[] -
- orderId? int -
- trackingUrl? string -
- shipmentStatus? anydata? -
- status? string -
shopify.admin: SingleFulfillmentOrder
Fields
- fulfillmentOrder? SingleFulfillmentOrderFulfillmentOrder -
shopify.admin: SingleFulfillmentOrderFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? SingleFulfillmentOrderFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? SingleFulfillmentOrderFulfillmentOrderLineItems[] -
- orderId? int -
- supportedActions? string[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: SingleFulfillmentOrderFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: SingleFulfillmentOrderFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: SingleFulfillmentService
Fields
- fulfillmentService? SingleFulfillmentServiceFulfillmentService -
shopify.admin: SingleFulfillmentServiceFulfillmentService
Fields
- callbackUrl? string -
- inventoryManagement? boolean -
- serviceName? string -
- fulfillmentOrdersOptIn? boolean -
- name? string -
- providerId? anydata? -
- 'handle? string -
- id? int -
- includePendingStock? boolean -
- email? anydata? -
- locationId? int -
- trackingSupport? boolean -
shopify.admin: SingleGiftCard
Fields
- giftCard? SingleGiftCardGiftCard -
shopify.admin: SingleGiftCardGiftCard
Fields
- note? anydata? -
- initialValue? string -
- lineItemId? anydata? -
- apiClientId? anydata? -
- disabledAt? anydata? -
- expiresOn? anydata? -
- createdAt? string -
- templateSuffix? anydata? -
- balance? string -
- updatedAt? string -
- userId? anydata? -
- currency? string -
- id? int -
- customerId? anydata? -
- lastCharacters? string -
- orderId? anydata? -
shopify.admin: SingleLocation
Fields
- location? SingleLocationLocation -
shopify.admin: SingleLocationLocation
Fields
- zip? anydata? -
- country? string -
- legacy? boolean -
- address2? anydata? -
- city? anydata? -
- address1? anydata? -
- active? boolean -
- createdAt? string -
- provinceCode? anydata? -
- countryCode? string -
- province? anydata? -
- updatedAt? string -
- phone? anydata? -
- adminGraphqlApiId? string -
- countryName? string -
- name? string -
- id? int -
shopify.admin: SingleOrderResponse
Fields
- 'order? SingleOrderResponseOrder -
shopify.admin: SingleOrderResponseOrder
Fields
- cancelledAt? anydata? -
- fulfillmentStatus? anydata? -
- totalPriceUsd? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ReopenCloseOrderOrderLineItems[] -
- presentmentCurrency? string -
- totalDiscountsSet? ReopenCloseOrderOrderTotalDiscountsSet -
- locationId? anydata? -
- sourceUrl? anydata? -
- landingSite? string -
- sourceIdentifier? string -
- reference? string -
- number? int -
- checkoutId? int -
- checkoutToken? string -
- taxLines? ReopenCloseOrderOrderTaxLines1[] -
- customerLocale? anydata? -
- id? int -
- appId? anydata? -
- subtotalPrice? string -
- closedAt? anydata? -
- orderStatusUrl? string -
- deviceId? anydata? -
- test? boolean -
- totalShippingPriceSet? ReopenCloseOrderOrderTotalDiscountSet -
- subtotalPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- paymentGatewayNames? string[] -
- totalTax? string -
- processingMethod? string -
- shippingLines? ReopenCloseOrderOrderShippingLines[] -
- phone? string -
- userId? anydata? -
- noteAttributes? ReopenCloseOrderOrderNoteAttributes[] -
- name? string -
- cartToken? string -
- totalTaxSet? ReopenCloseOrderOrderPriceSet2 -
- landingSiteRef? string -
- discountCodes? ReopenCloseOrderOrderDiscountCodes[] -
- note? anydata? -
- paymentDetails? ReopenCloseOrderOrderPaymentDetails -
- orderNumber? int -
- discountApplications? ReopenCloseOrderOrderDiscountApplications[] -
- createdAt? string -
- totalLineItemsPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- taxesIncluded? boolean -
- buyerAcceptsMarketing? boolean -
- confirmed? boolean -
- totalWeight? int -
- contactEmail? string -
- refunds? ReopenCloseOrderOrderRefunds[] -
- totalDiscounts? string -
- fulfillments? ReopenCloseOrderOrderFulfillments[] -
- clientDetails? ReopenCloseOrderOrderClientDetails -
- referringSite? string -
- updatedAt? string -
- processedAt? string -
- currency? string -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- browserIp? string -
- email? string -
- sourceName? string -
- totalPriceSet? ReopenCloseOrderOrderTotalPriceSet -
- totalPrice? string -
- totalLineItemsPrice? string -
- token? string -
- cancelReason? anydata? -
- adminGraphqlApiId? string -
- financialStatus? string -
- gateway? string -
- customer? ReopenCloseOrderOrderCustomer -
shopify.admin: SingleOrderRisk
Fields
- risk? SingleOrderRiskRisk -
shopify.admin: SingleOrderRiskRisk
Fields
- score? string -
- checkoutId? anydata? -
- display? boolean -
- recommendation? string -
- causeCancel? boolean -
- merchantMessage? string -
- id? int -
- 'source? string -
- message? string -
- orderId? int -
shopify.admin: SinglePageResponse
Fields
- page? SinglePageResponsePage -
shopify.admin: SinglePageResponsePage
Fields
- shopId? int -
- bodyHtml? string -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- createdAt? string -
- 'handle? string -
- id? int -
- publishedAt? string -
- title? string -
shopify.admin: SinglePaymentResponse
Fields
- payment? SinglePaymentResponsePayment -
shopify.admin: SinglePaymentResponsePayment
Fields
- uniqueToken? string -
- creditCard? anydata? -
- paymentProcessingErrorMessage? anydata? -
- nextAction? SinglePaymentResponsePaymentNextAction -
- id? int -
- checkout? SinglePaymentResponsePaymentCheckout -
- 'transaction? SinglePaymentResponsePaymentCheckoutTransaction -
- fraudulent? boolean -
shopify.admin: SinglePaymentResponsePaymentCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? SinglePaymentResponsePaymentCheckoutTaxLines[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? SinglePaymentResponsePaymentCheckoutShippingRate -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? SinglePaymentResponsePaymentCheckoutShippingLine? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? SinglePaymentResponsePaymentCheckoutPayments[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? SinglePaymentResponsePaymentCheckoutCreditCard -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: SinglePaymentResponsePaymentCheckoutBillingAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- company? anydata? -
- id? int -
- firstName? string -
shopify.admin: SinglePaymentResponsePaymentCheckoutCreditCard
Fields
- expiryMonth? int -
- firstDigits? string -
- lastName? string -
- customerId? anydata? -
- brand? string -
- firstName? string -
- lastDigits? string -
- expiryYear? int -
shopify.admin: SinglePaymentResponsePaymentCheckoutLineItems
Fields
- variantTitle? string? -
- linePrice? string -
- compareAtPrice? anydata? -
- quantity? int -
- fulfillmentService? string -
- giftCard? boolean -
- taxable? boolean -
- requiresShipping? boolean -
- imageUrl? string -
- title? string -
- variantId? int? -
- price? string -
- vendor? string -
- productId? int? -
- id? string -
- grams? int -
- sku? string? -
- appliedDiscounts? anydata[] -
- 'key? string -
- properties? record {} -
shopify.admin: SinglePaymentResponsePaymentCheckoutNoteAttributes
Fields
- colour? string -
- customEngraving? string -
shopify.admin: SinglePaymentResponsePaymentCheckoutPayments
Fields
- uniqueToken? string -
- creditCard? anydata? -
- paymentProcessingErrorMessage? anydata? -
- id? int -
- 'transaction? SinglePaymentResponsePaymentCheckoutTransaction -
- fraudulent? boolean -
shopify.admin: SinglePaymentResponsePaymentCheckoutShippingLine
Fields
- price? string -
- 'handle? string -
- title? string -
shopify.admin: SinglePaymentResponsePaymentCheckoutShippingRate
Fields
- price? string -
- id? string -
- title? string -
shopify.admin: SinglePaymentResponsePaymentCheckoutTaxLines
Fields
- compareAt? decimal -
- rate? decimal -
- price? string -
- title? string -
shopify.admin: SinglePaymentResponsePaymentCheckoutTransaction
Fields
- amountIn? anydata? -
- amount? string -
- deviceId? anydata? -
- test? boolean -
- kind? string -
- createdAt? string -
- message? anydata? -
- locationId? anydata? -
- amountOut? anydata? -
- transactionGroupId? anydata? -
- userId? anydata? -
- parentId? anydata? -
- amountRounding? anydata? -
- currency? string -
- errorCode? anydata? -
- receipt? record {} -
- id? int -
- gateway? string -
- status? string -
shopify.admin: SinglePaymentResponsePaymentNextAction
Fields
- redirectUrl? anydata? -
shopify.admin: SinglePayout
Fields
- payout? PayoutsListPayouts -
shopify.admin: SinglePriceRule
Fields
- priceRule? SinglePriceRulePriceRule -
shopify.admin: SinglePriceRulePriceRule
Fields
- oncePerCustomer? boolean -
- startsAt? string -
- usageLimit? anydata? -
- valueType? string -
- createdAt? string -
- prerequisiteCustomerIds? anydata[] -
- title? string -
- entitledCollectionIds? anydata[] -
- updatedAt? string -
- prerequisiteProductIds? anydata[] -
- prerequisiteShippingPriceRange? anydata? -
- entitledCountryIds? anydata[] -
- entitledVariantIds? anydata[] -
- endsAt? string? -
- id? int -
- value? string -
- prerequisiteSubtotalRange? anydata? -
- allocationMethod? string -
- prerequisiteToEntitlementQuantityRatio? UpdatePriceRulePriceRulePrerequisiteToEntitlementQuantityRatio -
- prerequisiteQuantityRange? anydata? -
- allocationLimit? anydata? -
- targetType? string -
- entitledProductIds? anydata[] -
- customerSelection? string -
- prerequisiteSavedSearchIds? anydata[] -
- adminGraphqlApiId? string -
- prerequisiteVariantIds? anydata[] -
- targetSelection? string -
- prerequisiteCollectionIds? anydata[] -
shopify.admin: SingleProduct
Fields
- product? SingleProductProduct -
shopify.admin: SingleProductImage
Fields
- image? ProductImagesImages -
shopify.admin: SingleProductProduct
Fields
- image? ProductsResponseImages -
- bodyHtml? string -
- images? ProductsResponseImages[] -
- createdAt? string -
- 'handle? string -
- variants? SingleProductProductVariants[] -
- title? string -
- publishedScope? string -
- productType? string -
- templateSuffix? anydata? -
- updatedAt? string -
- vendor? string -
- adminGraphqlApiId? string -
- options? ProductListingsOptions[] -
- id? int -
- publishedAt? string -
shopify.admin: SingleProductProductVariants
Fields
- presentmentPrices? ProductVariantsPresentmentPrices[] -
- inventoryManagement? string -
- oldInventoryQuantity? int -
- requiresShipping? boolean -
- createdAt? string -
- title? string -
- updatedAt? string -
- inventoryItemId? int -
- price? string -
- productId? int? -
- option3? anydata? -
- option1? string -
- id? int -
- option2? anydata? -
- grams? int -
- sku? string? -
- barcode? string -
- inventoryQuantity? int -
- compareAtPrice? anydata? -
- fulfillmentService? string -
- taxable? boolean -
- weight? decimal -
- inventoryPolicy? string -
- weightUnit? string -
- adminGraphqlApiId? string -
- position? int -
- imageId? int? -
shopify.admin: SingleProvince
Fields
- province? SingleProvinceProvince -
shopify.admin: SingleProvinceProvince
Fields
- code? string -
- taxType? string -
- taxName? string -
- name? string -
- taxPercentage? decimal -
- tax? decimal -
- id? int -
- shippingZoneId? anydata? -
- countryId? int -
shopify.admin: SingleRedirect
Fields
- redirect? SingleRedirectRedirect -
shopify.admin: SingleRedirectRedirect
Fields
- path? string -
- id? int -
- target? string -
shopify.admin: SingleReportResponse
Fields
- report? ReportListReports -
shopify.admin: SingleScriptTag
Fields
- scriptTag? SingleScriptTagScriptTag -
shopify.admin: SingleScriptTagScriptTag
Fields
- updatedAt? string -
- src? string -
- createdAt? string -
- id? int -
- displayScope? string -
- event? string -
shopify.admin: SingleTheme
Fields
- theme? SingleThemeTheme -
shopify.admin: SingleThemeTheme
Fields
- role? string -
- updatedAt? string -
- adminGraphqlApiId? string -
- themeStoreId? anydata? -
- name? string -
- createdAt? string -
- processing? boolean -
- id? int -
- previewable? boolean -
shopify.admin: SingleUsageCharge
Fields
- usageCharge? SingleUsageChargeUsageCharge -
shopify.admin: SingleUsageChargeUsageCharge
Fields
- riskLevel? decimal -
- price? string -
- balanceUsed? decimal -
- balanceRemaining? decimal -
- createdAt? string -
- description? string -
- billingOn? anydata? -
- currency? string -
- id? int -
shopify.admin: SingleUser
Fields
- user? SingleUserUser -
shopify.admin: SingleUserUser
Fields
- im? anydata? -
- bio? anydata? -
- lastName? string -
- locale? string -
- accountOwner? boolean -
- url? string -
- receiveAnnouncements? int -
- userType? string -
- phone? anydata? -
- screenName? anydata? -
- permissions? string[] -
- adminGraphqlApiId? string -
- tfaEnabled? boolean -
- id? int -
- firstName? string -
- email? string -
shopify.admin: SingleWebhook
Fields
- webhook? SingleWebhookWebhook -
shopify.admin: SingleWebhookWebhook
Fields
- address? string -
- metafieldNamespaces? anydata[] -
- updatedAt? string -
- format? string -
- createdAt? string -
- topic? string -
- id? int -
- apiVersion? string -
- fields? anydata[] -
- privateMetafieldNamespaces? anydata[] -
shopify.admin: SmartCollectionList
Fields
- smartCollections? SmartCollectionListSmartCollections[] -
shopify.admin: SmartCollectionListSmartCollections
Fields
- bodyHtml? string? -
- 'handle? string -
- rules? SmartCollectionResponseSmartCollectionRules[] -
- title? string -
- publishedScope? string -
- templateSuffix? anydata? -
- updatedAt? string -
- disjunctive? boolean -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string -
- sortOrder? string -
shopify.admin: SmartCollectionResponse
Fields
- smartCollection? SmartCollectionResponseSmartCollection -
shopify.admin: SmartCollectionResponseSmartCollection
Fields
- bodyHtml? string -
- productsCount? int -
- 'handle? string -
- rules? SmartCollectionResponseSmartCollectionRules[] -
- title? string -
- publishedScope? string -
- templateSuffix? anydata? -
- updatedAt? string -
- disjunctive? boolean -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string -
- sortOrder? string -
shopify.admin: SmartCollectionResponseSmartCollectionRules
Fields
- condition? string -
- column? string -
- relation? string -
shopify.admin: SmartCollectionssmartCollectionIdJsonBody
Fields
- smartCollection? AdminapiapiVersionsmartCollectionssmartCollectionIdJsonSmartCollection -
shopify.admin: SpamCommentResponse
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? anydata? -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: StorefrontAccessToken
Fields
- storefrontAccessToken? StorefrontAccessTokenStorefrontAccessToken -
shopify.admin: StorefrontAccessTokens
Fields
- storefrontAccessTokens? StorefrontAccessTokensStorefrontAccessTokens[] -
shopify.admin: StorefrontAccessTokensStorefrontAccessTokens
Fields
- accessToken? string -
- accessScope? string -
- adminGraphqlApiId? string -
- createdAt? string -
- id? int -
- title? string -
shopify.admin: StorefrontAccessTokenStorefrontAccessToken
Fields
- accessToken? string -
- accessScope? string -
- adminGraphqlApiId? string -
- createdAt? string -
- id? int -
- title? string -
shopify.admin: StoreLocationCount
Fields
- count? int -
shopify.admin: SubscribeOrderCreation
Fields
- webhook? SubscribeOrderCreationWebhook -
shopify.admin: SubscribeOrderCreationWebhook
Fields
- address? string -
- metafieldNamespaces? anydata[] -
- updatedAt? string -
- format? string -
- createdAt? string -
- topic? string -
- id? int -
- apiVersion? string -
- fields? anydata[] -
- privateMetafieldNamespaces? anydata[] -
shopify.admin: SubscriptionsList
Fields
- webhooks? SingleWebhookWebhook[] -
shopify.admin: TagsList
Fields
shopify.admin: TenderTransactions
Fields
- tenderTransactions? TenderTransactionsTenderTransactions[] -
shopify.admin: TenderTransactionsPaymentDetails
Fields
- creditCardNumber? string -
- creditCardCompany? string -
shopify.admin: TenderTransactionsTenderTransactions
Fields
- amount? string -
- paymentDetails? TenderTransactionsPaymentDetails -
- test? boolean -
- userId? anydata? -
- remoteReference? string -
- processedAt? string -
- currency? string -
- id? int -
- orderId? int -
- paymentMethod? string -
shopify.admin: ThemeIdAssetsJsonBody
Fields
shopify.admin: ThemesList
Fields
- themes? ThemesListThemes[] -
shopify.admin: ThemesListThemes
Fields
- role? string -
- updatedAt? string -
- adminGraphqlApiId? string -
- themeStoreId? int? -
- name? string -
- createdAt? string -
- processing? boolean -
- id? int -
- previewable? boolean -
shopify.admin: ThemesthemeIdJsonBody
Fields
shopify.admin: TokenPaymentsJsonBody
Fields
shopify.admin: TransactionObject
Fields
- 'transaction? TransactionObjectTransaction -
shopify.admin: TransactionObjectTransaction
Fields
- amount? string -
- deviceId? anydata? -
- test? boolean -
- kind? string -
- createdAt? string -
- message? string -
- locationId? anydata? -
- userId? anydata? -
- parentId? int -
- adminGraphqlApiId? string -
- currencyExchangeAdjustment? anydata? -
- processedAt? string -
- currency? string -
- errorCode? anydata? -
- receipt? record {} -
- id? int -
- orderId? int -
- gateway? string -
- sourceName? string -
- status? string -
shopify.admin: TransactionResponse
Fields
- 'transaction? TransactionResponseTransaction -
shopify.admin: TransactionResponseTransaction
Fields
- amount? string -
- deviceId? anydata? -
- paymentDetails? ReopenCloseOrderOrderPaymentDetails -
- test? boolean -
- kind? string -
- createdAt? string -
- message? anydata? -
- locationId? anydata? -
- userId? anydata? -
- parentId? anydata? -
- adminGraphqlApiId? string -
- currencyExchangeAdjustment? anydata? -
- processedAt? string -
- currency? string -
- errorCode? anydata? -
- receipt? ReopenCloseOrderOrderReceipt -
- id? int -
- orderId? int -
- gateway? string -
- sourceName? string -
- status? string -
shopify.admin: TransactionsList
Fields
- transactions? TransactionsListTransactions[] -
shopify.admin: TransactionsListForPayout
Fields
- transactions? TransactionsListForPayoutTransactions[] -
shopify.admin: TransactionsListForPayoutTransactions
Fields
- amount? string -
- test? boolean -
- fee? string -
- sourceOrderId? int? -
- sourceType? string? -
- 'type? string -
- payoutId? int -
- payoutStatus? string -
- processedAt? string -
- sourceOrderTransactionId? int? -
- currency? string -
- id? int -
- sourceId? int? -
- net? string -
shopify.admin: TransactionsListTransactions
Fields
- amount? string -
- deviceId? anydata? -
- paymentDetails? ReopenCloseOrderOrderPaymentDetails -
- test? boolean -
- kind? string -
- createdAt? string -
- message? anydata? -
- locationId? anydata? -
- userId? anydata? -
- parentId? int? -
- adminGraphqlApiId? string -
- currencyExchangeAdjustment? anydata? -
- processedAt? string -
- currency? string -
- errorCode? anydata? -
- receipt? ReopenCloseOrderOrderReceipt -
- id? int -
- orderId? int -
- gateway? string -
- sourceName? string -
- status? string -
shopify.admin: TransitionFulfillmentOrder
Fields
- fulfillmentOrder? TransitionFulfillmentOrderFulfillmentOrder -
shopify.admin: TransitionFulfillmentOrderFulfillmentOrder
Fields
- requestStatus? string -
- fulfillmentServiceHandle? string -
- shopId? int -
- destination? TransitionFulfillmentOrderFulfillmentOrderDestination -
- assignedLocationId? int -
- id? int -
- lineItems? TransitionFulfillmentOrderFulfillmentOrderLineItems[] -
- orderId? int -
- supportedActions? string[] -
- assignedLocation? FulfillmentOrdersAssignedLocation -
- merchantRequests? anydata[] -
- status? string -
shopify.admin: TransitionFulfillmentOrderFulfillmentOrderDestination
Fields
- zip? string -
- country? string -
- province? string -
- address2? string -
- city? string -
- phone? string -
- address1? string -
- lastName? string -
- company? anydata? -
- id? int -
- firstName? string -
- email? string -
shopify.admin: TransitionFulfillmentOrderFulfillmentOrderLineItems
Fields
- fulfillmentOrderId? int -
- shopId? int -
- fulfillableQuantity? int -
- lineItemId? int -
- quantity? int -
- variantId? int? -
- inventoryItemId? int -
- id? int -
shopify.admin: UpdateBlogResponse
Fields
- blog? UpdateBlogResponseBlog -
shopify.admin: UpdateBlogResponseBlog
Fields
- feedburner? anydata? -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- feedburnerLocation? anydata? -
- createdAt? string -
- 'handle? string -
- id? int -
- title? string -
- commentable? string -
shopify.admin: UpdateCarrierService
Fields
- carrierService? UpdateCarrierServiceCarrierService -
shopify.admin: UpdateCarrierServiceCarrierService
Fields
- callbackUrl? string -
- carrierServiceType? string -
- adminGraphqlApiId? string -
- format? string -
- name? string -
- serviceDiscovery? boolean -
- active? boolean -
- id? int -
shopify.admin: UpdateCheckoutResponse
Fields
- checkout? UpdateCheckoutResponseCheckout -
shopify.admin: UpdateCheckoutResponseCheckout
Fields
- privacyPolicyUrl? anydata? -
- paymentUrl? string -
- refundPolicyUrl? anydata? -
- requiresShipping? boolean -
- termsOfSaleUrl? anydata? -
- billingAddress? SinglePaymentResponsePaymentCheckoutBillingAddress? -
- lineItems? SinglePaymentResponsePaymentCheckoutLineItems[] -
- presentmentCurrency? string -
- locationId? anydata? -
- reservationTimeLeft? int -
- sourceUrl? anydata? -
- paymentDue? string -
- sourceIdentifier? anydata? -
- taxLines? anydata[] -
- customerLocale? anydata? -
- taxManipulations? anydata[] -
- 'order? anydata? -
- termsOfServiceUrl? anydata? -
- subtotalPrice? string -
- subscriptionPolicyUrl? anydata? -
- orderStatusUrl? anydata? -
- deviceId? anydata? -
- taxExempt? boolean -
- discountCode? anydata? -
- totalTax? string -
- completedAt? anydata? -
- shippingRate? anydata? -
- phone? anydata? -
- userId? anydata? -
- noteAttributes? SinglePaymentResponsePaymentCheckoutNoteAttributes -
- name? string -
- shippingLine? anydata? -
- orderId? anydata? -
- note? string? -
- appliedDiscount? anydata? -
- payments? anydata[] -
- createdAt? string -
- shopifyPaymentsAccountId? anydata? -
- taxesIncluded? boolean -
- updatedAt? string -
- currency? string -
- shippingAddress? UpdateCheckoutResponseCheckoutShippingAddress? -
- email? string -
- sourceName? string -
- totalPrice? string -
- legalNoticeUrl? anydata? -
- totalLineItemsPrice? string -
- reservationTime? anydata? -
- totalTipReceived? string -
- token? string -
- creditCard? anydata? -
- giftCards? anydata[] -
- webUrl? string -
- shippingPolicyUrl? anydata? -
- customerId? int -
shopify.admin: UpdateCheckoutResponseCheckoutShippingAddress
Fields
- zip? string -
- country? string -
- address2? string -
- city? string -
- address1? string -
- lastName? string -
- provinceCode? string -
- countryCode? string -
- province? string -
- phone? string -
- company? anydata? -
- id? int -
- firstName? string -
shopify.admin: UpdateCommentResponse
Fields
- comment? UpdateCommentResponseComment -
shopify.admin: UpdateCommentResponseComment
Fields
- blogId? int -
- bodyHtml? string -
- ip? string -
- createdAt? string -
- body? string -
- articleId? int -
- updatedAt? string -
- id? int -
- publishedAt? string -
- email? string -
- userAgent? string -
- status? string -
shopify.admin: UpdateCountryTaxRate
Fields
- country? UpdateCountryTaxRateCountry -
shopify.admin: UpdateCountryTaxRateCountry
Fields
- provinces? UpdateCountryTaxRateCountryProvinces[] -
- code? string -
- taxName? string -
- name? string -
- tax? decimal -
- id? int -
shopify.admin: UpdateCountryTaxRateCountryProvinces
Fields
- code? string -
- taxType? string? -
- taxName? string -
- name? string -
- taxPercentage? decimal -
- tax? decimal -
- id? int -
- shippingZoneId? anydata? -
- countryId? int -
shopify.admin: UpdateCustomCollection
Fields
- customCollection? UpdateCustomCollectionCustomCollection -
shopify.admin: UpdateCustomCollectionCustomCollection
Fields
- publishedScope? string -
- bodyHtml? string -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- 'handle? string -
- id? int -
- publishedAt? string? -
- title? string -
- sortOrder? string -
shopify.admin: UpdateCustomCollectionCustomCollectionImage
Fields
- src? string -
- alt? string -
- width? int -
- createdAt? string -
- height? int -
shopify.admin: UpdateCustomer
Fields
- customer? Customer -
shopify.admin: UpdateDiscountCode
Fields
- discountCode? UpdateDiscountCodeDiscountCode -
shopify.admin: UpdateDiscountCodeDiscountCode
Fields
- usageCount? int -
- code? string -
- updatedAt? string -
- priceRuleId? int -
- createdAt? string -
- id? int -
shopify.admin: UpdateFulfillmentService
Fields
- fulfillmentService? UpdateFulfillmentServiceFulfillmentService -
shopify.admin: UpdateFulfillmentServiceFulfillmentService
Fields
- callbackUrl? string -
- inventoryManagement? boolean -
- serviceName? string -
- fulfillmentOrdersOptIn? boolean -
- name? string -
- providerId? anydata? -
- 'handle? string -
- id? int -
- includePendingStock? boolean -
- email? anydata? -
- locationId? int -
- trackingSupport? boolean -
shopify.admin: UpdateGiftCard
Fields
- giftCard? UpdateGiftCardGiftCard -
shopify.admin: UpdateGiftCardGiftCard
Fields
- note? string? -
- initialValue? string -
- lineItemId? anydata? -
- apiClientId? anydata? -
- disabledAt? anydata? -
- expiresOn? string? -
- createdAt? string -
- templateSuffix? anydata? -
- balance? string -
- updatedAt? string -
- userId? anydata? -
- currency? string -
- id? int -
- customerId? anydata? -
- lastCharacters? string -
- orderId? anydata? -
shopify.admin: UpdateInventoryItem
Fields
- inventoryItem? UpdateInventoryItemInventoryItem -
shopify.admin: UpdateInventoryItemInventoryItem
Fields
- cost? string -
- updatedAt? string -
- requiresShipping? boolean -
- adminGraphqlApiId? string -
- createdAt? string -
- provinceCodeOfOrigin? anydata? -
- tracked? boolean -
- countryCodeOfOrigin? anydata? -
- id? int -
- sku? string? -
- countryHarmonizedSystemCodes? anydata[] -
- harmonizedSystemCode? anydata? -
shopify.admin: UpdateMarketingEvent
Fields
- marketingEvent? UpdateMarketingEventMarketingEvent -
shopify.admin: UpdateMarketingEventMarketingEvent
Fields
- manageUrl? anydata? -
- utmCampaign? string -
- remoteId? string -
- utmMedium? string -
- description? anydata? -
- eventType? string -
- previewUrl? anydata? -
- adminGraphqlApiId? string -
- paid? boolean -
- marketingActivityId? anydata? -
- startedAt? string -
- currency? string -
- id? int -
- marketingChannel? string -
- marketedResources? anydata[] -
- scheduledToEndAt? string -
- budgetType? string -
- endedAt? string -
- budget? string -
- referringDomain? string -
- utmSource? string -
shopify.admin: UpdateOrder
The Order object to be updated
Fields
- 'order? ReopenCloseOrderOrder -
shopify.admin: UpdateOrderResponse
Fields
- 'order? UpdateOrderResponseOrder -
shopify.admin: UpdateOrderResponseOrder
Fields
- cancelledAt? anydata? -
- fulfillmentStatus? anydata? -
- totalPriceUsd? string -
- billingAddress? ReopenCloseOrderOrderBillingAddress? -
- lineItems? ReopenCloseOrderOrderLineItems[] -
- presentmentCurrency? string -
- totalDiscountsSet? ReopenCloseOrderOrderTotalDiscountsSet -
- locationId? anydata? -
- sourceUrl? anydata? -
- landingSite? string -
- sourceIdentifier? string -
- reference? string -
- number? int -
- checkoutId? int -
- checkoutToken? string -
- taxLines? ReopenCloseOrderOrderTaxLines1[] -
- customerLocale? anydata? -
- id? int -
- appId? anydata? -
- subtotalPrice? string -
- closedAt? anydata? -
- orderStatusUrl? string -
- deviceId? anydata? -
- test? boolean -
- totalShippingPriceSet? ReopenCloseOrderOrderTotalDiscountSet -
- subtotalPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- paymentGatewayNames? string[] -
- totalTax? string -
- processingMethod? string -
- shippingLines? ReopenCloseOrderOrderShippingLines[] -
- phone? string -
- userId? anydata? -
- noteAttributes? UpdateOrderResponseOrderNoteAttributes[] -
- name? string -
- cartToken? string -
- totalTaxSet? ReopenCloseOrderOrderPriceSet2 -
- landingSiteRef? string -
- discountCodes? ReopenCloseOrderOrderDiscountCodes[] -
- note? string? -
- paymentDetails? ReopenCloseOrderOrderPaymentDetails -
- orderNumber? int -
- discountApplications? ReopenCloseOrderOrderDiscountApplications[] -
- createdAt? string -
- totalLineItemsPriceSet? ReopenCloseOrderOrderSubtotalPriceSet -
- taxesIncluded? boolean -
- buyerAcceptsMarketing? boolean -
- confirmed? boolean -
- totalWeight? int -
- contactEmail? string -
- refunds? ReopenCloseOrderOrderRefunds[] -
- totalDiscounts? string -
- fulfillments? ReopenCloseOrderOrderFulfillments[] -
- clientDetails? ReopenCloseOrderOrderClientDetails -
- referringSite? string -
- updatedAt? string -
- processedAt? string -
- currency? string -
- shippingAddress? ReopenCloseOrderOrderBillingAddress? -
- browserIp? string -
- email? string -
- sourceName? string -
- totalPriceSet? ReopenCloseOrderOrderTotalPriceSet -
- totalPrice? string -
- totalLineItemsPrice? string -
- token? string -
- cancelReason? anydata? -
- adminGraphqlApiId? string -
- financialStatus? string -
- gateway? string -
- customer? ReopenCloseOrderOrderCustomer -
shopify.admin: UpdateOrderResponseOrderNoteAttributes
Fields
- name? string -
- value? string -
shopify.admin: UpdateOrderRisk
Fields
- risk? UpdateOrderRiskRisk -
shopify.admin: UpdateOrderRiskRisk
Fields
- score? string -
- checkoutId? anydata? -
- display? boolean -
- recommendation? string -
- causeCancel? boolean -
- merchantMessage? string -
- id? int -
- 'source? string -
- message? string -
- orderId? int -
shopify.admin: UpdatePageResponse
Fields
- page? UpdatePageResponsePage -
shopify.admin: UpdatePageResponsePage
Fields
- shopId? int -
- bodyHtml? string -
- templateSuffix? anydata? -
- updatedAt? string -
- adminGraphqlApiId? string -
- createdAt? string -
- 'handle? string -
- id? int -
- publishedAt? string? -
- title? string -
shopify.admin: UpdatePriceRule
Fields
- priceRule? UpdatePriceRulePriceRule -
shopify.admin: UpdatePriceRulePriceRule
Fields
- oncePerCustomer? boolean -
- startsAt? string -
- usageLimit? anydata? -
- valueType? string -
- createdAt? string -
- prerequisiteCustomerIds? anydata[] -
- title? string -
- entitledCollectionIds? anydata[] -
- updatedAt? string -
- prerequisiteProductIds? anydata[] -
- prerequisiteShippingPriceRange? anydata? -
- entitledCountryIds? anydata[] -
- entitledVariantIds? anydata[] -
- endsAt? string? -
- id? int -
- value? string -
- prerequisiteSubtotalRange? anydata? -
- allocationMethod? string -
- prerequisiteToEntitlementQuantityRatio? UpdatePriceRulePriceRulePrerequisiteToEntitlementQuantityRatio -
- prerequisiteQuantityRange? anydata? -
- allocationLimit? anydata? -
- targetType? string -
- entitledProductIds? anydata[] -
- customerSelection? string -
- prerequisiteSavedSearchIds? anydata[] -
- adminGraphqlApiId? string -
- prerequisiteVariantIds? anydata[] -
- targetSelection? string -
- prerequisiteCollectionIds? anydata[] -
shopify.admin: UpdatePriceRulePriceRulePrerequisiteToEntitlementQuantityRatio
Fields
- prerequisiteQuantity? anydata? -
- entitledQuantity? anydata? -
shopify.admin: UpdateProduct
Fields
- product? UpdateProductProduct -
shopify.admin: UpdateProductProduct
Fields
- image? UpdateProductProductImage? -
- bodyHtml? string -
- images? UpdateProductProductImages[] -
- createdAt? string -
- 'handle? string -
- variants? SingleProductProductVariants[] -
- title? string -
- publishedScope? string -
- productType? string -
- templateSuffix? anydata? -
- updatedAt? string -
- vendor? string -
- adminGraphqlApiId? string -
- options? ProductListingsOptions[] -
- id? int -
- publishedAt? string? -
shopify.admin: UpdateProductProductImage
Fields
- updatedAt? string -
- src? string -
- adminGraphqlApiId? string -
- productId? int? -
- alt? anydata? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: UpdateProductProductImages
Fields
- updatedAt? string -
- src? string -
- adminGraphqlApiId? string -
- productId? int? -
- alt? anydata? -
- width? int -
- createdAt? string -
- variantIds? anydata[] -
- id? int -
- position? int -
- height? int -
shopify.admin: UpdateProductVariant
Fields
- variant? ProductVariant - A variant can be added to a Product resource to represent one version of a product with several options. The Product resource will have a variant for every possible combination of its options. Each product can have a maximum of three options and a maximum of 100 variants
shopify.admin: UpdateProvinceResponse
Fields
- province? UpdateProvinceResponseProvince -
shopify.admin: UpdateProvinceResponseProvince
Fields
- code? string -
- taxType? string -
- taxName? string -
- name? string -
- taxPercentage? decimal -
- tax? decimal -
- id? int -
- shippingZoneId? anydata? -
- countryId? int -
shopify.admin: UpdateRedirect
Fields
- redirect? UpdateRedirectRedirect -
shopify.admin: UpdateRedirectRedirect
Fields
- path? string -
- id? int -
- target? string -
shopify.admin: UpdateReportResponse
Fields
- report? UpdateReportResponseReport -
shopify.admin: UpdateReportResponseReport
Fields
- updatedAt? string -
- name? string -
- id? int -
- category? string -
- shopifyQl? string -
shopify.admin: UpdateScriptTagResponse
Fields
- scriptTag? UpdateScriptTagResponseScriptTag -
shopify.admin: UpdateScriptTagResponseScriptTag
Fields
- updatedAt? string -
- src? string -
- createdAt? string -
- id? int -
- displayScope? string -
- event? string -
shopify.admin: UpdateSmartCollection
Fields
- smartCollection? UpdateSmartCollectionSmartCollection -
shopify.admin: UpdateSmartCollectionSmartCollection
Fields
- bodyHtml? string -
- 'handle? string -
- rules? SmartCollectionResponseSmartCollectionRules[] -
- title? string -
- publishedScope? string -
- templateSuffix? anydata? -
- updatedAt? string -
- disjunctive? boolean -
- adminGraphqlApiId? string -
- id? int -
- publishedAt? string? -
- sortOrder? string -
shopify.admin: UpdateTheCappedAmountOfARecurringApplicationChargeQueries
Represents the Queries record for the operation: updateTheCappedAmountOfARecurringApplicationCharge
Fields
- recurringApplicationChargeCappedAmount? string - The new maximum amount that can be charged to the store. Must be greater than or equal to the current capped amount.
shopify.admin: UpdateWebhook
Fields
- webhook? UpdateWebhookWebhook -
shopify.admin: UpdateWebhookWebhook
Fields
- address? string -
- metafieldNamespaces? anydata[] -
- updatedAt? string -
- format? string -
- createdAt? string -
- topic? string -
- id? int -
- apiVersion? string -
- fields? anydata[] -
- privateMetafieldNamespaces? anydata[] -
shopify.admin: UrlList
Fields
- redirects? UrlListRedirects[] -
shopify.admin: UrlListRedirects
Fields
- path? string -
- id? int -
- target? string -
shopify.admin: UsageChargeList
Fields
- usageCharges? UsageChargeListUsageCharges[] -
shopify.admin: UsageChargeListUsageCharges
Fields
- riskLevel? decimal -
- price? string -
- balanceUsed? decimal -
- balanceRemaining? decimal -
- createdAt? string -
- description? string -
- billingOn? anydata? -
- currency? string -
- id? int -
shopify.admin: UsageChargeResponse
Fields
- usageCharge? UsageChargeResponseUsageCharge -
shopify.admin: UsageChargeResponseUsageCharge
Fields
- riskLevel? decimal -
- price? string -
- balanceUsed? decimal -
- balanceRemaining? decimal -
- createdAt? string -
- description? string -
- currency? string -
- id? int -
shopify.admin: UsersList
Fields
- users? SingleUserUser[] -
shopify.admin: Webhook
The webhook resource
Fields
- address? string - Destination URI to which the webhook subscription should send the POST request when an event occurs
- metafieldNamespaces? string[] - Optional array of namespaces for any metafields that should be included with each webhook
- updatedAt? string - Date and time when the webhook subscription was updated. The API returns this value in ISO 8601 format
- format? string - Format in which the webhook subscription should send the data. Valid values are JSON and XML. Defaults to JSON
- createdAt? string - Date and time when the webhook subscription was created. The API returns this value in ISO 8601 format
- topic? string - Event that triggers the webhook. Valid values are app/uninstalled, bulk_operations/finish, carts/create, carts/update, checkouts/create, checkouts/delete, checkouts/update, collection_listings/add, collection_listings/remove, collection_listings/update, collections/create, collections/delete, collections/update, customer_groups/create, customer_groups/delete, customer_groups/update, customer_payment_methods/create, customer_payment_methods/revoke, customer_payment_methods/update, customers/create, customers/delete, customers/disable, customers/enable, customers/update, customers_marketing_consent/update, disputes/create, disputes/update, domains/create, domains/destroy, domains/update, draft_orders/create, draft_orders/delete, draft_orders/update, fulfillment_events/create, fulfillment_events/delete, fulfillments/create, fulfillments/update, inventory_items/create, inventory_items/delete, inventory_items/update, inventory_levels/connect, inventory_levels/disconnect, inventory_levels/update, locales/create, locales/update, locations/create, locations/delete, locations/update, order_transactions/create, orders/cancelled, orders/create, orders/delete, orders/edited, orders/fulfilled, orders/paid, orders/partially_fulfilled, orders/updated, product_listings/add, product_listings/remove, product_listings/update, products/create, products/delete, products/update, profiles/create, profiles/delete, profiles/update, refunds/create, selling_plan_groups/create, selling_plan_groups/delete, selling_plan_groups/update, shop/update, subscription_billing_attempts/challenged, subscription_billing_attempts/failure, subscription_billing_attempts/success, subscription_contracts/create, subscription_contracts/update, tender_transactions/create, themes/create, themes/delete, themes/publish, themes/update
- id? int - Unique numeric identifier for the webhook subscription
- apiVersion? string - The Admin API version that Shopify uses to serialize webhook events. This value is inherited from the app that created the webhook subscription
- fields? string[] - An optional array of top-level resource fields that should be serialized and sent in the POST request. If absent, all fields will be sent
- privateMetafieldNamespaces? string[] - Optional array of namespaces for any private metafields that should be included with each webhook
shopify.admin: WebhookObject
The webhook object
Fields
- webhook? Webhook - The webhook resource