Shopify Admin API
  1. DraftOrder
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
        POST
      • Retrieves a list of draft orders
        GET
      • Modify an existing DraftOrder
        PUT
      • Receive a single DraftOrder
        GET
      • Remove an existing DraftOrder
        DELETE
      • Receive a count of all DraftOrders
        GET
      • Send an invoice
        POST
      • Complete a draft order
        PUT
    • 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
  1. DraftOrder

Complete a draft order

PUT
/admin/api/{api_version}/draft_orders/{draft_order_id}/complete.json
Completes a draft order.
Using the DraftOrder resource, you can create a draft order and transition it to an order.
The following flows are supported:
  • Create a draft order that calculates taxes and totals
    but accept payment from the customer outside of Shopify.
  • Create a draft order and send an invoice to the customer.

请求参数

Path 参数

Query 参数

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://demo.myshopify.com//admin/api//draft_orders//complete.json'

返回响应

🟢200Complete a draft order
application/json
Body

示例
{
    "draft_order": {
        "id": 994118539,
        "note": "rush order",
        "email": "bob.norman@mail.example.com",
        "taxes_included": false,
        "currency": "USD",
        "invoice_sent_at": null,
        "created_at": "2023-01-03T12:56:35-05:00",
        "updated_at": "2023-01-03T12:58:20-05:00",
        "tax_exempt": false,
        "completed_at": "2023-01-03T12:58:20-05:00",
        "name": "#D2",
        "status": "completed",
        "line_items": [
            {
                "id": 994118539,
                "variant_id": 39072856,
                "product_id": 632910392,
                "title": "IPod Nano - 8gb",
                "variant_title": "green",
                "sku": "IPOD2008GREEN",
                "vendor": null,
                "quantity": 1,
                "requires_shipping": false,
                "taxable": true,
                "gift_card": false,
                "fulfillment_service": "manual",
                "grams": 567,
                "tax_lines": [],
                "applied_discount": null,
                "name": "IPod Nano - 8gb - green",
                "properties": [],
                "custom": false,
                "price": "199.00",
                "admin_graphql_api_id": "gid://shopify/DraftOrderLineItem/994118539"
            }
        ],
        "shipping_address": {
            "first_name": "Bob",
            "address1": "Chestnut Street 92",
            "phone": "+1(502)-459-2181",
            "city": "Louisville",
            "zip": "40202",
            "province": "Kentucky",
            "country": "United States",
            "last_name": "Norman",
            "address2": "",
            "company": null,
            "latitude": 45.41634,
            "longitude": -75.6868,
            "name": "Bob Norman",
            "country_code": "US",
            "province_code": "KY"
        },
        "billing_address": {
            "first_name": "Bob",
            "address1": "Chestnut Street 92",
            "phone": "+1(502)-459-2181",
            "city": "Louisville",
            "zip": "40202",
            "province": "Kentucky",
            "country": "United States",
            "last_name": "Norman",
            "address2": "",
            "company": null,
            "latitude": 45.41634,
            "longitude": -75.6868,
            "name": "Bob Norman",
            "country_code": "US",
            "province_code": "KY"
        },
        "invoice_url": "https://jsmith.myshopify.com/548380009/invoices/ba8dcf6c022ccad3d47e3909e378e33f",
        "applied_discount": {
            "description": "$5promo",
            "value": "5.0",
            "title": null,
            "amount": "5.00",
            "value_type": "fixed_amount"
        },
        "order_id": 1073459975,
        "shipping_line": {
            "title": "UPS Ground",
            "custom": false,
            "handle": "ups-3-12.25",
            "price": "12.25"
        },
        "tax_lines": [],
        "tags": "Wholesale",
        "note_attributes": [],
        "total_price": "206.25",
        "subtotal_price": "194.00",
        "total_tax": "0.00",
        "presentment_currency": "USD",
        "total_line_items_price_set": {
            "shop_money": {
                "amount": "826.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "826.00",
                "currency_code": "USD"
            }
        },
        "total_price_set": {
            "shop_money": {
                "amount": "206.25",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "206.25",
                "currency_code": "USD"
            }
        },
        "subtotal_price_set": {
            "shop_money": {
                "amount": "194.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "194.00",
                "currency_code": "USD"
            }
        },
        "total_tax_set": {
            "shop_money": {
                "amount": "0.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "0.00",
                "currency_code": "USD"
            }
        },
        "total_discounts_set": {
            "shop_money": {
                "amount": "5.00",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "5.00",
                "currency_code": "USD"
            }
        },
        "total_shipping_price_set": {
            "shop_money": {
                "amount": "12.25",
                "currency_code": "USD"
            },
            "presentment_money": {
                "amount": "12.25",
                "currency_code": "USD"
            }
        },
        "payment_terms": null,
        "admin_graphql_api_id": "gid://shopify/DraftOrder/994118539",
        "customer": {
            "id": 207119551,
            "email": "bob.norman@mail.example.com",
            "accepts_marketing": false,
            "created_at": "2023-01-03T12:56:35-05:00",
            "updated_at": "2023-01-03T12:58:20-05:00",
            "first_name": "Bob",
            "last_name": "Norman",
            "orders_count": 2,
            "state": "disabled",
            "total_spent": "405.90",
            "last_order_id": 1073459975,
            "note": null,
            "verified_email": true,
            "multipass_identifier": null,
            "tax_exempt": false,
            "tags": "",
            "last_order_name": "#1002",
            "currency": "USD",
            "phone": "+16136120707",
            "accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
            "marketing_opt_in_level": null,
            "tax_exemptions": [],
            "email_marketing_consent": {
                "state": "not_subscribed",
                "opt_in_level": null,
                "consent_updated_at": "2004-06-13T11:57:11-04:00"
            },
            "sms_marketing_consent": {
                "state": "not_subscribed",
                "opt_in_level": "single_opt_in",
                "consent_updated_at": "2023-01-03T12:56:35-05:00",
                "consent_collected_from": "OTHER"
            },
            "admin_graphql_api_id": "gid://shopify/Customer/207119551",
            "default_address": {
                "id": 1053317316,
                "customer_id": 207119551,
                "first_name": "Bob",
                "last_name": "Norman",
                "company": null,
                "address1": "Chestnut Street 92",
                "address2": "",
                "city": "Louisville",
                "province": "Kentucky",
                "country": "United States",
                "zip": "40202",
                "phone": "+1(502)-459-2181",
                "name": "Bob Norman",
                "province_code": "KY",
                "country_code": "US",
                "country_name": "United States",
                "default": true
            }
        }
    }
}
修改于 2023-01-29 12:00:32
上一页
Send an invoice
下一页
Creates an order risk for an order
Built with