Update Shipment API

Attach recipient and delivery metadata (userMetas) to a cart before checkout.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Schema

ParameterTypeDescription
cartIdStringCart ID to update.
userMetasString (JSON)JSON-encoded recipient/delivery metadata. Common fields: email, contact. Product-specific: MemberId (loyalty), topupPhoneCode/topupPhoneNumber (mobile top-up), flightDepartureDate/flightNumber (airmiles), or a nested shipment address block.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.updateShipmentobjectContainer for the shipment update result.
data.updateShipment.statusnumberAPI execution status (1 = success).
data.updateShipment.messagestringResult message (e.g. Shipment updated successfully).

Implementation Notes

  1. userMetas must be sent as a JSON-encoded string, not a JSON object.
  2. Refer to the product metadata in Get Vouchers API to determine which fields a product requires.
  3. This response is taken from an actual staging call.
Body Params
string
required
Defaults to plumProAPI.mutation.updateShipment

Please use 'plumProAPI.mutation.updateShipment' always in query

string
required
Defaults to plumProAPI

Please use 'plumProAPI' always in tag.

variables
object
required
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json