OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Set Customer Address Detail

AI-generated

Summary

Set or update customer address details in OnPrintShop using the Complete API with a specified input object containing address information.

Inputs

  • Input (required) — Customer address details to set, provided as a CustomerAddressInput JSON object. Can be entered as individual fields or as a JSON object, including fields such as user ID, address book ID, city, country, phone number, and more.
  • Safe Mode — Optional flag to block mutations in the Complete API. Default is false.
  • Partial Response — Specify behavior on partial failures: Fail on errors or Return partial data.
  • Return Fields Mode — Choose to return all fields or a custom selection of fields from the mutation result.
  • Return Fields — If 'Custom Selection' is chosen, specify which fields (ID, Message, Result) to return.

Output shape

a single object containing the mutation result with fields such as result, message, and ID indicating the outcome of the operation.

The operation returns the response from the setCustomerAddressDetail mutation. If errors occur, they are thrown as node errors. Return fields can be customized or all returned by default.

Examples

Example 1: Update a customer's address

Provide an input object with the customer's user_id and the relevant address fields to be set or updated (e.g., city, street address, postcode). On execution, the node performs the mutation and returns the result status and any messages from OnPrintShop.

Links

Discussion