Orders > Order Fulfillments > orderFulfillmentsEventsCreate
Commerce APIOrdersOrder FulfillmentsorderFulfillmentsEventsCreate
orderFulfillmentsEventsCreate
POST:order_fulfillments/events.json

Description

Create one or more order fulfillment tracking events.

Permission bit: "fulfillments.event"

Topic: Order Fulfillments

Arguments

data: [FulfillmentTrackingEventCreate!]!

Main argument for mutations.


fulfillment_id: String!

Unique order fulfillment identifier. See also: Unique Identifiers

Example: "fu_EQzGqWoY"


order_id: String!

Unique order identifier. See also: Unique Identifiers

Example: "or_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

city: String

City of the event (comes from shipping provider)

Valid when: city's length doesn't exceed 250 characters


code: String

Shipping provider-specific code of the event

Example: "AFP-ER13"

Valid when: code's length doesn't exceed 250 characters


country: String

Country code of the event (comes from shipping provider)

Valid when: country's length doesn't exceed 250 characters


description: String

Free form description of the event

Example: "Arrived at facility"

Valid when: description's length doesn't exceed 250 characters


province: String

Province code of the event (comes from shipping provider)

Valid when: province's length doesn't exceed 250 characters


status: TrackingEventStatus

Event status


zip: String

Zip or postal code of the event (comes from shipping provider)

Valid when: zip's length doesn't exceed 250 characters


Result

OrderFulfillment

Preview (typescript)

Loading module