Admin API/Shipping and fulfillment/Mutations

fulfillmentEventCreate

mutation

Records a delivery status (in transit, delivered, refused, returned…). Updates the order, the customer's delivery record and stock.

Returns FulfillmentEventCreatePayload!

mutation FulfillmentEventCreate($fulfillmentId: ID!, $status: FulfillmentEventStatus!) {
  fulfillmentEventCreate(fulfillmentId: $fulfillmentId, status: $status) {
    fulfillment {
      id
      status
      deliveredAt
      displayStatus
      returnedAt
      shippedAt
    }
    userErrors {
      code
      message
      field
    }
  }
}

# Variables
{
  "fulfillmentId": "gid://ostorya/Fulfillment/0f8c5b1e-…",
  "status": "ATTEMPTED_DELIVERY"
}

Arguments

fulfillmentIdID!required
happenedAtDateTime
messageString
statusFulfillmentEventStatus!required

Payload

fulfillmentFulfillment
userErrors[UserError!]!required

mutation FulfillmentEventCreate($fulfillmentId: ID!, $status: FulfillmentEventStatus!) { fulfillmentEventCreate(fulfillmentId: $fulfillmentId, status: $status) { fulfillment { id status deliveredAt displayStatus returnedAt shippedAt } userErrors { code message field } } } # Variables { "fulfillmentId": "gid://ostorya/Fulfillment/0f8c5b1e-…", "status": "ATTEMPTED_DELIVERY" }