fulfillmentEventCreate

Creates a FulfillmentEvent to track the shipment status and location of items that have shipped.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the fulfillmentEventCreate action (under Fulfillment).
Fill in the fields below, then reference the result from later steps as {{fulfillmenteventcreate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation FulfillmentEventCreate($fulfillmentEvent: FulfillmentEventInput!) {
  fulfillmentEventCreate(fulfillmentEvent: $fulfillmentEvent) {
    fulfillmentEvent {
      address1
      city
      country
      createdAt
      estimatedDeliveryAt
      happenedAt
      id
      latitude
      longitude
      message
      province
      status
      zip
    }
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

fulfillmentEventobjectrequired

The input fields used to create a fulfillment event for a fulfillment.

address1string

citystring

countrystring

estimatedDeliveryAtstring

happenedAtstring

fulfillmentIdstringrequired

latitudenumber

longitudenumber

messagestring

provincestring

statusstringrequired

One ofLABEL_PURCHASEDLABEL_PRINTEDREADY_FOR_PICKUPCONFIRMEDIN_TRANSITOUT_FOR_DELIVERYATTEMPTED_DELIVERYDELAYEDDELIVEREDFAILURECARRIER_PICKED_UP

zipstring

json

{
  "fulfillmentEvent": {
    "fulfillmentId": "string",
    "status": "LABEL_PURCHASED",
    "address1": "string",
    "city": "string",
    "country": "string",
    "estimatedDeliveryAt": "string",
    "happenedAt": "string",
    "latitude": 0,
    "longitude": 0,
    "message": "string",
    "province": "string",
    "zip": "string"
  }
}

Response

Read the result with {{fulfillmenteventcreate.response.data.data.fulfillmentEventCreate}}. If the API returns errors, the step fails and they are at {{fulfillmenteventcreate.response.data.errors}}.

fulfillmentEventobject

address1string

citystring

countrystring

createdAtstring

estimatedDeliveryAtstring

happenedAtstring

idstring

latitudenumber

longitudenumber

messagestring

provincestring

statusstring

One ofLABEL_PURCHASEDLABEL_PRINTEDREADY_FOR_PICKUPCONFIRMEDIN_TRANSITOUT_FOR_DELIVERYATTEMPTED_DELIVERYDELAYEDDELIVEREDFAILURECARRIER_PICKED_UP

zipstring

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?