ParcelMutation
Fields
createBotBot!RequiredinputCreateBotInput!RequiredavatarUrlStringbotTypeBotType!RequiredcategoryStringconfigurationJSONdescriptionStringdisplayNameString!RequiredisPublicBooleanusernameString!RequiredwebhookSecretStringwebhookUrlStringcreateLocationLocation!RequiredinputCreateLocationInput!RequiredaddressString!RequiredcityStringcountryStringdeliveryAvailableBooleandeliveryRadiusFloatemailStringisActiveBooleanlatitudeFloatlongitudeFloatnameString!RequiredphoneStringpickupAvailableBooleanpostalCodeStringstateStringcreateVendorCouponCoupon!RequiredinputCreateVendorCouponInput!RequiredcodeString!RequiredcolorString!RequireddescriptionStringdiscountDecimal!RequiredexpiresOnDateTimeforDeliveryBoolean!RequiredisActiveBoolean!RequiredmaxCouponAmountDecimalminOrderAmountDecimalpercentageBoolean!RequiredproductIds[Int!]RequiredtimesIntvendorLocationIds[Int!]RequiredcreateWebhookWebhook!RequiredinputCreateWebhookInput!Requiredevents[WebhookEvent!]!RequiredisActiveBooleanurlString!RequireddeleteBotBoolean!RequiredbotIdInt!RequireddeleteLocationBoolean!RequiredlocationIdInt!RequireddeletePackagePricingBoolean!RequiredpricingIdInt!RequireddeleteVendorCouponBoolean!RequiredcouponIdInt!RequireddeleteWebhookBoolean!RequiredwebhookIdInt!RequiredprovisionUnitCredentialAutonomousUnitCredential!RequiredidInt!RequiredregenerateBotSecretString!RequiredbotIdInt!RequiredregenerateWebhookSecretString!RequiredwebhookIdInt!RequiredregisterUnitAutonomousUnit!RequiredinputRegisterVendorAutonomousUnitInput!RequiredcountryIdIntfirmwareVersionStringhomeBaseLocationIdIntmakeStringmaxRangeKmFloat!RequiredmaxSpeedKphFloat!RequiredmodelStringpayloadCapacityKgFloat!RequiredserialNoString!RequiredunitKindAutonomousUnitKind!RequiredrevokeUnitCredentialBoolean!RequiredidInt!RequiredsetUnitStatusBoolean!RequiredidInt!RequiredstatusAutonomousUnitStatus!RequiredtestBotWebhookBotWebhookTest!RequiredbotIdInt!RequiredupdateBotBot!RequiredbotIdInt!RequiredinputUpdateBotInput!RequiredavatarUrlStringcategoryStringconfigurationJSONdescriptionStringdisplayNameStringisPublicBooleanwebhookSecretStringwebhookUrlStringupdateLocationLocation!RequiredinputUpdateLocationInput!RequiredaddressStringcityStringcountryStringdeliveryAvailableBooleandeliveryRadiusFloatemailStringisActiveBooleanlatitudeFloatlongitudeFloatnameStringphoneStringpickupAvailableBooleanpostalCodeStringstateStringlocationIdInt!RequiredupdatePackagePricingPackageTypePricingData!RequiredpriceDecimal!RequiredpricingIdInt!RequiredupdateUnitAutonomousUnit!RequiredidInt!RequiredinputUpdateOwnAutonomousUnitInput!RequiredfirmwareVersionStringhomeBaseLocationIdIntisActiveBooleanmakeStringmaxRangeKmFloatmaxSpeedKphFloatmodelStringpayloadCapacityKgFloatupdateVendorCouponCoupon!RequiredcouponIdInt!RequiredinputUpdateVendorCouponInput!RequiredcodeStringcolorStringdescriptionStringdiscountDecimalexpiresOnDateTimeforDeliveryBooleanisActiveBooleanmaxCouponAmountDecimalminOrderAmountDecimalpercentageBooleanproductIds[Int!]RequiredtimesIntvendorLocationIds[Int!]RequiredupdateWebhookWebhook!RequiredinputUpdateWebhookInput!Requiredevents[WebhookEvent!]RequiredisActiveBooleanurlStringwebhookIdInt!RequiredupsertPackagePricingPackageTypePricingData!RequiredpackageTypeIdInt!RequiredpriceDecimal!Required
Create a new bot owned by the authenticated vendor.
Requires a user-context token, unlike the other bot mutations: The bot records a human author, which is required and must be a real user. A client_credentials token has no honest value to put there, and inventing one would corrupt the attribution the public bot directory renders.
Details of the bot to create.
URL of the bot's avatar image.
Which runtime surface the bot plugs into.
Directory category the bot is filed under.
Free-form JSON configuration passed through to the bot runtime.
What the bot does, shown in the directory. Up to 500 characters.
Human-readable name shown in chat and the directory. 2–100 characters.
Whether to list the bot in the public directory. Defaults to false.
Handle the bot is mentioned by, without the leading @. 3–50 characters, alphanumeric and underscores only, and unique platform-wide.
Shared secret the delivery signature is computed with. 32–128
characters. Store it — it is never returned again.
HTTPS URL to deliver the bot's events to. Without one it receives nothing.
Create a new location for the authenticated vendor.
Details of the location to create.
Street address of the branch.
City the branch is in.
Country the branch is in.
Whether the branch delivers. Defaults to true.
How far the branch delivers, in kilometres. Omit for unlimited.
Contact email address for the branch.
Whether the branch is in service. Defaults to true.
Latitude in decimal degrees (WGS 84).
Longitude in decimal degrees (WGS 84).
Branch name, e.g. Downtown store.
Contact phone number for the branch.
Whether customers can collect from this branch. Defaults to true.
Postal or ZIP code.
State, province or region the branch is in.
Create a coupon on this vendor's storefront.
The code must be unique platform-wide, so a collision with an existing
coupon — including another vendor's — is rejected.
Details of the coupon to create.
Code customers type at checkout. Must be unique across the platform.
Hex colour for UI display (e.g. "#FF5733").
Terms or explanation shown with the coupon. Optional.
Percentage when percentage is true, otherwise a fixed amount.
Never negative: the order paths subtract this, so a negative value would increase what the customer pays.
When the coupon stops working (UTC). Omit for a coupon that never expires.
Whether the discount applies to the delivery fee.
Whether the coupon can be redeemed straight away.
Caps a percentage discount. Ignored for fixed amounts.
Smallest order the coupon applies to, in the vendor's currency. Omit for no minimum.
Whether discount is a percentage rather than a fixed amount.
Restrict to specific products. All of the vendor's products when empty.
Total redemptions allowed across all customers.
Restrict to specific locations. Valid at all of the vendor's locations
when omitted or empty.
Register a new webhook endpoint for the authenticated business.
Endpoint URL and the events to subscribe to.
Events to subscribe to. At least one.
Whether to start delivering immediately. Defaults to active.
HTTPS URL to deliver events to.
Permanently delete a bot. Returns true on success.
Unique identifier of the bot to delete.
Delete a location. Returns true on success.
Unique identifier of the location to delete.
Delete a pricing row the vendor owns. Returns true on success.
Unique identifier of the pricing rule to delete.
Delete a coupon this vendor owns.
Unique identifier of the coupon to delete.
Permanently delete a webhook. Returns true on success.
Unique identifier of the webhook endpoint to delete.
Issue machine credentials for a unit.
The plaintext secret is returned exactly once and only its hash is stored, so a lost secret can only be replaced, never recovered. Re-provisioning a credentialed unit is refused rather than silently rotating — that would strand the unit in the field with a secret nobody holds.
Unit to issue a new credential for.
Regenerate a webhook bot's secret, invalidating the previous one.
Returns the new secret so the caller can update their webhook handler.
Unique identifier of the bot to issue a new secret for.
Rotate a webhook's signing secret, returning the new secret. The new
value is only surfaced here — it is stored hashed-in-place and cannot be
retrieved again afterwards.
Webhook whose signing secret to replace.
Register a unit against the acting vendor, which owns it.
Details of the unit to register.
Country the unit is registered in. Optional.
Firmware the unit is running, up to 64 characters. Optional.
Depot the unit returns to between jobs. Optional.
Manufacturer name, up to 128 characters. Optional.
One-way range. Dispatch requires this to cover the round trip.
Top speed in kilometres per hour (0.1 to 300).
Model name, up to 128 characters. Optional.
Kilograms the unit can carry. Must be positive — a unit that can
carry nothing can never be dispatched.
Manufacturer serial number, 3-128 characters. Must be unique.
Whether the unit is a drone, a ground robot or a pavement robot.
Revoke a unit's credentials.
Takes effect immediately: an already-issued token stops working on its
next call rather than surviving until it expires.
Unique identifier of the unit whose credentials to revoke.
Report a unit's operational status.
Restricted to the states an owner legitimately controls. Assigned, Enroute and Returning follow from dispatch decisions and Disabled is an administrative act — accepting either here would let an owner desynchronise a unit from its live job or quietly un-ground it.
Unit to update.
Status to move the unit to.
Queue a test webhook delivery for a webhook-type bot.
Bot whose webhook endpoint to test.
Update an existing bot. Permissions, version and tags are not editable
through the developer API.
Bot to update.
Fields to change on the bot.
Replacement avatar image URL.
Replacement directory category.
Replacement JSON configuration. Replaces the stored blob outright.
Replacement description. Up to 500 characters.
Replacement display name. 2–100 characters.
Whether the bot is listed in the public directory.
Rotated signing secret. 32–128 characters. Supplying it invalidates the
previous secret immediately.
Replacement HTTPS delivery URL.
Update an existing location.
Fields to change on the location.
Replacement street address.
Replacement city.
Replacement country.
Whether the branch delivers.
Replacement delivery radius in kilometres.
Replacement contact email address.
Whether the branch is in service.
Replacement latitude in decimal degrees (WGS 84).
Replacement longitude in decimal degrees (WGS 84).
Replacement branch name.
Replacement contact phone number.
Whether customers can collect from this branch.
Replacement postal or ZIP code.
Replacement state, province or region.
Location to update.
Update an existing pricing row the vendor owns.
New price, in the vendor's currency.
Pricing entry to update.
Update a unit's mutable attributes.
Verification status is deliberately absent — a partner cannot verify
its own hardware. That stays an admin decision.
Unit to update.
Fields to change on the unit.
Firmware the unit is running, up to 64 characters.
Depot the unit returns to between jobs.
Whether the unit is in service.
Manufacturer name, up to 128 characters.
One-way range in kilometres (0.1 to 500).
Top speed in kilometres per hour (0.1 to 300).
Model name, up to 128 characters.
Weight the unit can carry, in kilograms (0.01 to 500).
Update a coupon this vendor owns.
Coupon to update.
Fields to change on the coupon.
New code customers type at checkout. Omit to leave it unchanged.
New hex colour for display (e.g. #FF5733). Omit to leave it unchanged.
New terms or explanation. Omit to leave it unchanged.
Never negative, for the same reason as on create: the order paths
subtract it.
New expiry (UTC). Omit to leave it unchanged.
Whether the discount applies to the delivery fee. Omit to leave it unchanged.
Whether the coupon can still be redeemed. Omit to leave it unchanged.
New cap on a percentage discount. Omit to leave it unchanged.
New order minimum, in the vendor's currency. Omit to leave it unchanged.
Whether discount is a percentage. Omit to leave it unchanged.
Replaces the product restriction outright. An empty list clears it.
New total redemption limit. Omit to leave it unchanged.
Replaces the location restriction outright. Some(vec![]) clears it.
Modify an existing webhook's URL, events, or active status.
Fields to change on the webhook.
Replacement subscription list. Replaces the existing set outright.
Whether the webhook delivers. Set false to pause without deleting.
Replacement HTTPS delivery URL.
Webhook to update.
Create or update the vendor's pricing for a package type.
Package type to price.
Price to charge, in the vendor's currency.
Built with