Choose a version:

fulfillment

query

Requires read_orders access scope, read_marketplace_orders access scope, read_assigned_fulfillment_orders access scope, read_merchant_managed_fulfillment_orders access scope, read_third_party_fulfillment_orders access scope or read_marketplace_fulfillment_orders access scope.

Returns a Fulfillment resource by ID.

Arguments

Anchor to idid • ID!required: The ID of the Fulfillment to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Fulfillment

•

Fulfillment

Represents a fulfillment. In Shopify, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer. There can be more than one fulfillment for an order.

createdAt• DateTime! non-null: The date and time when the fulfillment was created.
deliveredAt• DateTime: The date that this fulfillment was delivered.
displayStatus• FulfillmentDisplayStatus: Human readable display status for this fulfillment.
estimatedDeliveryAt• DateTime: The estimated date that this fulfillment will arrive.
events • FulfillmentEventConnection! non-null: The history of events associated with this fulfillment.
fulfillmentLineItems • FulfillmentLineItemConnection! non-null: List of the fulfillment's line items.
fulfillmentOrders • FulfillmentOrderConnection! non-null: A paginated list of fulfillment orders for the fulfillment.
id• ID! non-null: A globally-unique ID.
inTransitAt• DateTime: The date and time when the fulfillment went into transit.
legacyResourceId• UnsignedInt64! non-null: The ID of the corresponding resource in the REST Admin API.
location• Location: The location that the fulfillment was processed at.
name• String! non-null: Human readable reference identifier for this fulfillment.
order• Order! non-null: The order for which the fulfillment was created.
originAddress• FulfillmentOriginAddress: The address at which the fulfillment occurred. This field is intended for tax purposes, as a full address is required for tax providers to accurately calculate taxes. Typically this is the address of the warehouse or fulfillment center. To retrieve a fulfillment location's address, use the assignedLocation field on the FulfillmentOrder object instead.
requiresShipping• Boolean! non-null: Whether any of the line items in the fulfillment require shipping.
service• FulfillmentService: Fulfillment service associated with the fulfillment.
status• FulfillmentStatus! non-null: The status of the fulfillment.
totalQuantity• Int! non-null: Sum of all line item quantities for the fulfillment.
trackingInfo• [FulfillmentTrackingInfo!]! non-null: Tracking information associated with the fulfillment, such as the tracking company, tracking number, and tracking URL.
updatedAt• DateTime! non-null: The date and time when the fulfillment was last modified.

Was this section helpful?

Receive a single Fulfillment
Retrieves a list of fulfillment events for a specific fulfillment

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query FulfillmentShow($id: ID!) {

fulfillment(id: $id) {

fulfillmentLineItems(first: 10) {

edges {

node {

lineItem {

title

variant {

}

quantity

originalTotalSet {

shopMoney {

amount

currencyCode

}

status

estimatedDeliveryAt

location {

legacyResourceId

}

service {

handle

}

trackingInfo(first: 10) {

company

number

url

}

originAddress {

address1

address2

city

countryCode

provinceCode

zip

}

}`,

{

variables: {

"id": "gid://shopify/Fulfillment/237894043"

);

const data = await response.json();

query FulfillmentShow($id: ID!) {
  fulfillment(id: $id) {
    fulfillmentLineItems(first: 10) {
      edges {
        node {
          id
          lineItem {
            title
            variant {
              id
            }
          }
          quantity
          originalTotalSet {
            shopMoney {
              amount
              currencyCode
            }
          }
        }
      }
    }
    status
    estimatedDeliveryAt
    location {
      id
      legacyResourceId
    }
    service {
      handle
    }
    trackingInfo(first: 10) {
      company
      number
      url
    }
    originAddress {
      address1
      address2
      city
      countryCode
      provinceCode
      zip
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query FulfillmentShow($id: ID!) { fulfillment(id: $id) { fulfillmentLineItems(first: 10) { edges { node { id lineItem { title variant { id } } quantity originalTotalSet { shopMoney { amount currencyCode } } } } } status estimatedDeliveryAt location { id legacyResourceId } service { handle } trackingInfo(first: 10) { company number url } originAddress { address1 address2 city countryCode provinceCode zip } } }",
 "variables": {
    "id": "gid://shopify/Fulfillment/237894043"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query FulfillmentShow($id: ID!) {
    fulfillment(id: $id) {
      fulfillmentLineItems(first: 10) {
        edges {
          node {
            id
            lineItem {
              title
              variant {
                id
              }
            }
            quantity
            originalTotalSet {
              shopMoney {
                amount
                currencyCode
              }
            }
          }
        }
      }
      status
      estimatedDeliveryAt
      location {
        id
        legacyResourceId
      }
      service {
        handle
      }
      trackingInfo(first: 10) {
        company
        number
        url
      }
      originAddress {
        address1
        address2
        city
        countryCode
        provinceCode
        zip
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/Fulfillment/237894043"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query FulfillmentShow($id: ID!) {
      fulfillment(id: $id) {
        fulfillmentLineItems(first: 10) {
          edges {
            node {
              id
              lineItem {
                title
                variant {
                  id
                }
              }
              quantity
              originalTotalSet {
                shopMoney {
                  amount
                  currencyCode
                }
              }
            }
          }
        }
        status
        estimatedDeliveryAt
        location {
          id
          legacyResourceId
        }
        service {
          handle
        }
        trackingInfo(first: 10) {
          company
          number
          url
        }
        originAddress {
          address1
          address2
          city
          countryCode
          provinceCode
          zip
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/Fulfillment/237894043"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query FulfillmentShow($id: ID!) {
    fulfillment(id: $id) {
      fulfillmentLineItems(first: 10) {
        edges {
          node {
            id
            lineItem {
              title
              variant {
                id
              }
            }
            quantity
            originalTotalSet {
              shopMoney {
                amount
                currencyCode
              }
            }
          }
        }
      }
      status
      estimatedDeliveryAt
      location {
        id
        legacyResourceId
      }
      service {
        handle
      }
      trackingInfo(first: 10) {
        company
        number
        url
      }
      originAddress {
        address1
        address2
        city
        countryCode
        provinceCode
        zip
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Fulfillment/237894043"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"id": "gid://shopify/Fulfillment/237894043"

}

Response

JSON

{

"fulfillment": {

"fulfillmentLineItems": {

"edges": [

{

"node": {

"id": "gid://shopify/FulfillmentLineItem/761422146",

"lineItem": {

"title": "Draft",

"variant": {

"id": "gid://shopify/ProductVariant/43729076"

}

"quantity": 2,

"originalTotalSet": {

"shopMoney": {

"amount": "20.0",

"currencyCode": "USD"

}

]

"status": "SUCCESS",

"estimatedDeliveryAt": null,

"location": {

"id": "gid://shopify/Location/124656943",

"legacyResourceId": "124656943"

"service": {

"handle": "manual"

"trackingInfo": [

{

"company": "UPS",

"number": "1Z1234512345123456",

"url": "https://www.ups.com/WebTracking?loc=en_US&requester=ST&trackNums=1Z1234512345123456"

}

"originAddress": {

"address1": "150 Elgin St",

"address2": null,

"city": "Ottawa",

"countryCode": "CA",

"provinceCode": "ON",

"zip": "K2P 1L4"

}