Shopify Admin API
  1. Orders
Shopify Admin API
  • Customers
    • Customer Address
      • Retrieves a list of addresses for a customer
      • Creates a new address for a customer
      • Retrieves details for a single customer address
      • Updates an existing customer address
      • Removes an address from a customer’s address list
      • Performs bulk operations for multiple customer addresses
      • Sets the default address for a customer
    • CustomerSavedSearch
      • Retrieves a list of customer saved searches
      • Creates a customer saved search
      • Retrieves a count of all customer saved searches
      • Retrieves a single customer saved search
      • Updates a customer saved search
      • Deletes a customer saved search
      • Retrieves all customers returned by a customer saved search
    • Customer
      • Retrieves a list of customers
      • Creates a customer
      • Searches for customers that match a supplied query
      • Retrieves a single customer
      • Updates a customer
      • Deletes a customer
      • Creates an account activation URL for a customer
      • Sends an account invite to a customer
      • Retrieves a count of customers
      • Retrieves all orders that belong to a customer
  • Sales channels
    • Checkout
      • Creates a checkout
      • Completes a checkout
      • Retrieves a checkout
      • Modifies an existing checkout
      • Retrieves a list of shipping rates
    • CollectionListing
      • Retrieve collection listings that are published to your app
      • Retrieve product_ids that are published to a collection_id
      • Retrieve a specific collection listing that is published to your app
      • Create a collection listing to publish a collection to your app
      • Delete a collection listing to unpublish a collection from your app
    • Product ResourceFeedback
      • Create a new Product ResourceFeedback
      • Receive a list of all Product ResourceFeedbacks
    • MobilePlatformApplication
      • List all of the mobile platform applications associated with the app
      • Create a mobile platform application
      • Get a mobile platform application
      • Update a mobile platform application
      • Delete a mobile platform application
    • ProductListing
      • Retrieve product listings that are published to your app
      • Retrieve product_ids that are published to your app
      • Retrieve a count of products that are published to your app
      • Retrieve a specific product listing that is published to your app
      • Create a product listing to publish a product to your app
      • Delete a product listing to unpublish a product from your app
    • ResourceFeedback
      • Create a new ResourceFeedback
      • Receive a list of all ResourceFeedbacks
    • Payment
      • Creates a new payment
      • Retrieves a list of payments on a particular checkout
      • Retrieves a single payment
      • Counts the number of payments attempted on a checkout
  • Products
    • Collect
      • Adds a product to a custom collection
      • Retrieves a list of collects
      • Removes a product from a collection
      • Retrieves a specific collect by its ID
      • Retrieves a count of collects
    • Collection
      • Retrieves a single collection
      • Retrieve a list of products belonging to a collection
    • CustomCollection
      • Retrieves a list of custom collections
      • Creates a custom collection
      • Retrieves a count of custom collections
      • Retrieves a single custom collection
      • Updates an existing custom collection
      • Deletes a custom collection
    • Product
      • Retrieve a list of products
      • Create a new product
      • Retrieve a count of products
      • Retrieve a single product
      • Updates a product
      • Delete a product
    • Product Image
      • Receive a list of all Product Images
      • Create a new Product Image
      • Receive a count of all Product Images
      • Receive a single Product Image
      • Modify an existing Product Image
      • Remove an existing Product Image
    • Product Variant
      • Retrieves a list of product variants
      • Create a new Product Variant
      • Receive a count of all Product Variants
      • Receive a single Product Variant
      • Modify an existing Product Variant
      • Remove an existing Product Variant
    • SmartCollection
      • Retrieves a list of smart collections
      • Creates a smart collection
      • Retrieves a count of smart collections
      • Retrieves a single smart collection
      • Updates an existing smart collection
      • Removes a smart collection
      • Updates the ordering type of products in a smart collection
  • Orders
    • Abandoned checkouts
      • Retrieves a list of abandoned checkouts
    • DraftOrder
      • Create a new DraftOrder
      • Retrieves a list of draft orders
      • Modify an existing DraftOrder
      • Receive a single DraftOrder
      • Remove an existing DraftOrder
      • Receive a count of all DraftOrders
      • Send an invoice
      • Complete a draft order
    • Order Risk
      • Creates an order risk for an order
      • Retrieves a list of all order risks for an order
      • Retrieves a single order risk by its ID
      • Updates an order risk
      • Deletes an order risk for an order
    • Transaction
      • Retrieves a list of transactions
      • Creates a transaction for an order
      • Retrieves a count of an order's transactions
      • Retrieves a specific transaction
    • Order
      • Retrieve a list of orders
      • Create an order
      • Retrieve a specific order
      • Update an order
      • Delete an order
      • Retrieve an order count
      • Close an order
      • Re-open a closed order
      • Cancel an order
    • Refund
      • Retrieves a list of refunds for an order
      • Creates a refund
      • Retrieves a specific refund
      • Calculates a refund
  • Access
    • AccessScope
      • Get a list of access scopes
    • StorefrontAccessToken
      • Creates a new StorefrontAccessToken
      • Retrieves a list of storefront access tokens that have been issued
      • Deletes an existing storefront access token
  • Billing
    • ApplicationCredit
      • Creates an application credit
      • Retrieves all application credits
      • Retrieves a single application credit
    • ApplicationCharge
      • Creates an application charge
      • Retrieves a list of application charges
      • Retrieves an application charge
    • UsageCharge
      • Creates a usage charge
      • Retrieves a list of usage charges
      • Retrieves a single charge
    • RecurringApplicationCharge
      • Creates a recurring application charge
      • Retrieves a list of recurring application charges
      • Retrieves a single charge
      • Cancels a recurring application charge
      • Updates the capped amount of a recurring application charge
  • Online store
    • Asset
      • Retrieves a single asset for a theme
      • Creates or updates an asset for a theme
      • Deletes an asset from a theme
    • Blog
      • Retrieve a list of all blogs
      • Create a new Blog
      • Receive a count of all Blogs
      • Receive a single Blog
      • Modify an existing Blog
      • Remove an existing Blog
    • Article
      • Retrieves a list of all articles from a blog
      • Creates an article for a blog
      • Retrieves a count of all articles from a blog
      • Receive a single Article
      • Updates an article
      • Deletes an article
      • Retrieves a list of all article authors
      • Retrieves a list of all article tags
      • Retrieves a list of all article tags from a specific blog
    • Redirect
      • Retrieves a list of URL redirects
      • Creates a redirect
      • Retrieves a count of URL redirects
      • Retrieves a single redirect
      • Updates an existing redirect
      • Deletes a redirect
    • Comment
      • Retrieves a list of comments
      • Creates a comment for an article
      • Retrieves a count of comments
      • Retrieves a single comment by its ID
      • Updates a comment of an article
      • Marks a comment as spam
      • Marks a comment as not spam
      • Approves a comment
      • Removes a comment
      • Restores a previously removed comment
    • ScriptTag
      • Retrieves a list of all script tags
      • Creates a new script tag
      • Retrieves a count of all script tags
      • Retrieves a single script tag
      • Updates a script tag
      • Deletes a script tag
    • Page
      • Retrieves a list of pages
      • Creates a page
      • Retrieves a page count
      • Retrieves a single page by its ID
      • Updates a page
      • Deletes a page
    • Theme
      • Retrieves a list of themes
      • Creates a theme
      • Retrieves a single theme by its ID
      • Modify an existing Theme
      • Remove an existing Theme
  • Shipping and fulfillment
    • CancellationRequest
      • Sends a cancellation request
      • Accepts a cancellation request
      • Rejects a cancellation request
    • CarrierService
      • Create a new CarrierService
      • Receive a list of all CarrierServices
      • Modify an existing CarrierService
      • Receive a single CarrierService
      • Remove an existing CarrierService
    • AssignedFulfillmentOrder
      • Retrieves a list of fulfillment orders on a shop for a specific app
    • FulfillmentEvent
      • Retrieves a list of fulfillment events for a specific fulfillment
      • Creates a fulfillment event
      • Retrieves a specific fulfillment event
      • Deletes a fulfillment event
    • Fulfillment
      • Retrieves fulfillments associated with an order
      • Retrieves fulfillments associated with a fulfillment order
      • Retrieves a count of fulfillments associated with a specific order
      • Receive a single Fulfillment
      • Creates a fulfillment for one or many fulfillment orders
      • Updates the tracking information for a fulfillment
      • Cancels a fulfillment
    • FulfillmentOrder
      • Retrieves a list of fulfillment orders for a specific order
      • Retrieves a specific fulfillment order
      • Cancel a fulfillment order
      • Marks a fulfillment order as incomplete
      • Moves a fulfillment order to a new location
      • Marks the fulfillment order as open
      • Reschedules the fulfill_at time of a scheduled fulfillment order
      • Applies a fulfillment hold on an open fulfillment order
      • Sets deadline for fulfillment orders
      • Releases the fulfillment hold on a fulfillment order
    • LocationsForMove
      • Retrieves a list of locations that a fulfillment order can potentially move to.
    • FulfillmentRequest
      • Sends a fulfillment request
      • Accepts a fulfillment request
      • Rejects a fulfillment request
    • FulfillmentService
      • Receive a list of all FulfillmentServices
      • Create a new FulfillmentService
      • Receive a single FulfillmentService
      • Modify an existing FulfillmentService
      • Remove an existing FulfillmentService
  • Shopify Payments
    • Balance
      • Return the current balance
    • Dispute
      • Return a list of all disputes
      • Return a single dispute
    • Payouts
      • Return a list of all payouts
      • Return a single payout
    • Transactions
      • Return a list of all balance transactions
  • Analytics
    • Report
      • Retrieves a list of reports
      • Creates a new report
      • Retrieves a single report
      • Updates a report
      • Deletes a report
  • Deprecated API calls
    • Deprecated API calls
      • Retrieves a list of deprecated API calls
  • Discounts
    • DiscountCode
      • Creates a discount code
      • Retrieves a list of discount codes
      • Updates an existing discount code
      • Retrieves a single discount code
      • Deletes a discount code
      • Retrieves the location of a discount code
      • Retrieves a count of discount codes for a shop
      • Creates a discount code creation job
      • Retrieves a discount code creation job
      • Retrieves a list of discount codes for a discount code creation job
    • PriceRule
      • Creates a price rule
      • Retrieves a list of price rules
      • Updates an existing a price rule
      • Retrieves a single price rule
      • Remove an existing PriceRule
      • Retrieves a count of all price rules
  • Inventory
    • InventoryItem
      • Retrieves a detailed list for inventory items by IDs
      • Retrieves a single inventory item by ID
      • Updates an existing inventory item
    • Location
      • Retrieve a list of locations
      • Retrieve a single location by its ID
      • Retrieve a count of locations
      • Retrieve a list of inventory levels for a location
    • InventoryLevel
      • Retrieves a list of inventory levels
      • Deletes an inventory level from a location
      • Adjusts the inventory level of an inventory item at a location
      • Connects an inventory item to a location
      • Sets the inventory level for an inventory item at a location
  • Events
    • Event
      • Retrieves a list of events
      • Retrieves a single event
      • Retrieves a count of events
    • Webhook
      • Retrieves a list of webhooks
      • Create a new Webhook
      • Receive a count of all Webhooks
      • Receive a single Webhook
      • Modify an existing Webhook
      • Remove an existing Webhook
  • MarketingEvent
    • MarketingEvent
      • Retrieves a list of all marketing events
      • Creates a marketing event
      • Retrieves a count of all marketing events
      • Retrieves a single marketing event
      • Updates a marketing event
      • Deletes a marketing event
      • Creates marketing engagements on a marketing event
  • Metafield
    • Metafield
      • Retrieve a list of metafields from the resource's endpoint
      • Create a metafield
      • Retrieve a list of metafields by using query parameters
      • Retrieve a count of a resource's metafields.
      • Retrieve a specific metafield
      • Updates a metafield
      • Deletes a metafield by its ID
  • Plus
    • Gift Card
      • Retrieves a list of gift cards
      • Creates a gift card
      • Retrieves a single gift card
      • Updates an existing gift card
      • Retrieves a count of gift cards
      • Disables a gift card
      • Searches for gift cards
    • User
      • Retrieves a list of all users
      • Retrieves a single user
      • Retrieves the currently logged-in user
  • Store properties
    • Country
      • Receive a list of all Countries
      • Creates a country
      • Retrieves a count of countries
      • Retrieves a specific county
      • Updates an existing country
      • Remove an existing Country
    • Currency
      • Retrieves a list of currencies enabled on a shop
    • Policy
      • Retrieves a list of the shop's policies
    • ShippingZone
      • Receive a list of all ShippingZones
    • Province
      • Retrieves a list of provinces for a country
      • Retrieves a count of provinces for a country
      • Retrieves a single province for a country
      • Updates an existing province for a country
    • Shop
      • Retrieves the shop's configuration
  • TenderTransaction
    • TenderTransaction
      • Retrieves a list of tender transactions
  • 数据模型
    • Sales channels
      • CollectionListing
      • MobilePlatformApplication
      • Product ResourceFeedback
      • Checkout
      • Payment
      • ResourceFeedback
      • ProductListing
    • Products
      • Collect
      • Collection
      • CustomCollection
      • Product Variant
      • Product
      • Product Image
      • SmartCollection
    • Orders
      • Abandoned checkouts
      • DraftOrder
      • Order Risk
      • Transaction
      • Order
      • Refund
    • Access
      • StorefrontAccessToken
      • AccessScope
    • Billing
      • ApplicationCharge
      • UsageCharge
      • RecurringApplicationCharge
      • ApplicationCredit
    • Online store
      • Article
      • Page
      • Asset
      • Blog
      • Redirect
      • Comment
      • ScriptTag
      • Theme
    • Shipping and fulfillment
      • AssignedFulfillmentOrder
      • CancellationRequest
      • CarrierService
      • Fulfillment
      • FulfillmentRequest
      • FulfillmentOrder
      • FulfillmentService
      • LocationsForMove
      • FulfillmentEvent
    • Shopify Payments
      • Dispute
      • Balance
      • Payouts
      • Transactions
    • Customers
      • Customer Address
      • CustomerSavedSearch
      • Customer
    • Analytics
      • Report
    • Deprecated API calls
      • Deprecated API calls
    • Discounts
      • DiscountCode
      • PriceRule
    • Inventory
      • InventoryLevel
      • Location
      • InventoryItem
    • Events
      • Event
      • Webhook
    • MarketingEvent
      • MarketingEvent
    • Metafield
      • Metafield
    • Plus
      • Gift Card
      • User
    • Store properties
      • Policy
      • Country
      • ShippingZone
      • Currency
      • Province
      • Shop
    • TenderTransaction
      • TenderTransaction
  1. Orders

Order(Order)

{
    "app_id": "string",
    "billing_address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "company": "string",
        "customer_id": "string",
        "first_name": "string",
        "id": "string",
        "last_name": "string",
        "name": "string",
        "phone": "string",
        "province": "string",
        "province_code": "string",
        "zip": "string"
    },
    "browser_ip": "string",
    "buyer_accepts_marketing": "string",
    "cancel_reason": "string",
    "cancelled_at": "string",
    "cart_token": "string",
    "checkout_token": "string",
    "client_details": "string",
    "closed_at": "string",
    "company": "string",
    "created_at": "string",
    "currency": "string",
    "current_total_discounts": "string",
    "current_total_discounts_set": "string",
    "current_total_duties_set": "string",
    "current_total_price": "string",
    "current_total_price_set": "string",
    "current_subtotal_price": "string",
    "current_subtotal_price_set": "string",
    "current_total_tax": "string",
    "current_total_tax_set": "string",
    "customer": {
        "accepts_marketing": "string",
        "accepts_marketing_updated_at": "string",
        "addresses": {
            "id": 207119551,
            "customer_id": 6940095564,
            "first_name": "Bob",
            "last_name": "Norman",
            "company": null,
            "address1": "Chestnut Street 92",
            "address2": "Apartment 2",
            "city": "Louisville",
            "province": "Kentucky",
            "country": "United States",
            "zip": "40202",
            "phone": "555-625-1199",
            "province_code": "KY",
            "country_code": "US",
            "country_name": "United States",
            "default": true
        },
        "currency": "string",
        "created_at": "string",
        "default_address": {
            "address1": "string",
            "address2": "string",
            "city": "string",
            "company": "string",
            "country": "string",
            "country_code": "string",
            "country_name": "string",
            "customer_id": "string",
            "default": "string",
            "first_name": "string",
            "id": "string",
            "last_name": "string",
            "name": "string",
            "phone": "string",
            "province": "string",
            "province_code": "string",
            "zip": "string"
        },
        "email": "string",
        "email_marketing_consent": {
            "state": "string"
        },
        "first_name": "string",
        "id": "string",
        "last_name": "string",
        "last_order_id": "string",
        "last_order_name": "string",
        "metafield": "string",
        "marketing_opt_in_level": "single_opt_in",
        "multipass_identifier": "string",
        "note": "string",
        "orders_count": "string",
        "password": "string",
        "password_confirmation": "string",
        "phone": "string",
        "sms_marketing_consent": {
            "state": "string",
            "consent_collected_from": "string"
        },
        "state": "disabled",
        "tags": "string",
        "tax_exempt": "string",
        "tax_exemptions": "EXEMPT_ALL",
        "total_spent": "string",
        "updated_at": "string",
        "verified_email": "string"
    },
    "customer_locale": "string",
    "discount_applications": "across",
    "discount_codes": "amount",
    "email": "user@example.com",
    "estimated_taxes": "string",
    "financial_status": "string",
    "fulfillments": {
        "created_at": "2012-03-13T16:09:54-04:00",
        "id": 255858046,
        "order_id": 450789469,
        "status": "failure",
        "tracking_company": "USPS",
        "tracking_number": "1Z2345",
        "updated_at": "2012-05-01T14:22:25-04:00"
    },
    "fulfillment_status": "string",
    "gateway": "string",
    "id": "string",
    "landing_site": "string",
    "line_items": {
        "fulfillable_quantity": 1,
        "fulfillment_service": "amazon",
        "fulfillment_status": "fulfilled",
        "grams": 500,
        "id": 669751112,
        "price": "199.99",
        "product_id": 7513594,
        "quantity": 1,
        "requires_shipping": true,
        "sku": "IPOD-342-N",
        "title": "IPod Nano",
        "variant_id": 4264112,
        "variant_title": "Pink",
        "vendor": "Apple",
        "name": "IPod Nano - Pink",
        "gift_card": false,
        "price_set": {
            "shop_money": {
                "amount": "199.99",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "173.30",
                "currency_code": "EUR"
            }
        },
        "properties": [
            {
                "name": "custom engraving",
                "value": "Happy Birthday Mom!"
            }
        ],
        "taxable": true,
        "tax_lines": [
            {
                "title": "HST",
                "price": "25.81",
                "price_set": {
                    "shop_money": {
                        "amount": "25.81",
                        "currency_code": "USD"
                    },
                    "presentment_money": {
                        "amount": "20.15",
                        "currency_code": "EUR"
                    }
                },
                "channel_liable": true,
                "rate": 0.13
            }
        ],
        "total_discount": "5.00",
        "total_discount_set": {
            "shop_money": {
                "amount": "5.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "4.30",
                "currency_code": "EUR"
            }
        },
        "discount_allocations": [
            {
                "amount": "5.00",
                "discount_application_index": 2,
                "amount_set": {
                    "shop_money": {
                        "amount": "5.00",
                        "currency_code": "USD"
                    },
                    "presentment_money": {
                        "amount": "3.96",
                        "currency_code": "EUR"
                    }
                }
            }
        ],
        "origin_location": {
            "id": 1390592786454,
            "country_code": "CA",
            "province_code": "ON",
            "name": "Apple",
            "address1": "700 West Georgia Street",
            "address2": "1500",
            "city": "Toronto",
            "zip": "V7Y 1G5"
        },
        "duties": [
            {
                "id": "2",
                "harmonized_system_code": "520300",
                "country_code_of_origin": "CA",
                "shop_money": {
                    "amount": "164.86",
                    "currency_code": "CAD"
                },
                "presentment_money": {
                    "amount": "105.31",
                    "currency_code": "EUR"
                },
                "tax_lines": [
                    {
                        "title": "VAT",
                        "price": "16.486",
                        "rate": 0.1,
                        "price_set": {
                            "shop_money": {
                                "amount": "16.486",
                                "currency_code": "CAD"
                            },
                            "presentment_money": {
                                "amount": "10.531",
                                "currency_code": "EUR"
                            }
                        },
                        "channel_liable": true
                    }
                ],
                "admin_graphql_api_id": "gid://shopify/Duty/2"
            }
        ]
    },
    "location_id": "string",
    "merchant_of_record_app_id": "string",
    "name": "string",
    "note": "string",
    "note_attributes": {
        "name": "custom name",
        "value": "custom value"
    },
    "number": "string",
    "order_number": "string",
    "original_total_duties_set": "string",
    "payment_details": "string",
    "payment_terms": "string",
    "payment_gateway_names": "authorize_net",
    "phone": "string",
    "presentment_currency": "string",
    "processed_at": "string",
    "processing_method": "string",
    "referring_site": "string",
    "refunds": {
        "id": 18423447608,
        "order_id": 394481795128,
        "created_at": "2018-03-06T09:35:37-05:00",
        "note": null,
        "user_id": null,
        "processed_at": "2018-03-06T09:35:37-05:00",
        "refund_line_items": [],
        "transactions": [],
        "order_adjustments": []
    },
    "shipping_address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "country_code": "string",
        "country_name": "string",
        "company": "string",
        "customer_id": "string",
        "first_name": "string",
        "id": "string",
        "last_name": "string",
        "name": "string",
        "phone": "string",
        "province": "string",
        "province_code": "string",
        "zip": "string"
    },
    "shipping_lines": {
        "code": "INT.TP",
        "price": "4.00",
        "price_set": {
            "shop_money": {
                "amount": "4.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "3.17",
                "currency_code": "EUR"
            }
        },
        "discounted_price": "4.00",
        "discounted_price_set": {
            "shop_money": {
                "amount": "4.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "3.17",
                "currency_code": "EUR"
            }
        },
        "source": "canada_post",
        "title": "Small Packet International Air",
        "tax_lines": [],
        "carrier_identifier": "third_party_carrier_identifier",
        "requested_fulfillment_service_id": "third_party_fulfillment_service_id"
    },
    "source_name": "string",
    "source_identifier": "string",
    "source_url": "string",
    "subtotal_price": "string",
    "subtotal_price_set": "string",
    "tags": "string",
    "tax_lines": {
        "price": 11.94,
        "rate": 0.06,
        "title": "State Tax",
        "channel_liable": true
    },
    "taxes_included": "string",
    "test": "string",
    "token": "string",
    "total_discounts": "string",
    "total_discounts_set": "string",
    "total_line_items_price": "string",
    "total_line_items_price_set": "string",
    "total_outstanding": "string",
    "total_price": "string",
    "total_price_set": "string",
    "total_shipping_price_set": "string",
    "total_tax": "string",
    "total_tax_set": "string",
    "total_tip_received": "string",
    "total_weight": "string",
    "updated_at": "string",
    "user_id": "string",
    "order_status_url": "string"
}
Built with