SoraiDocs
GuidesAPI reference

sorai products update

Change some of a product's fields.

Only the fields you pass change; everything else keeps its current value.

sorai products update --product-id <uuid> [flags]

Flags

  • --store <id|slug>: A store id or slug. Defaults to SORAI_STORE, the saved login's store, or the only store.
  • --product-id <uuid> (required): The product's id, from sorai products list.
  • --slug <string>
  • --name <string>
  • --kind <file|course|membership|license|service|bundle>
  • --status <draft|active|archived>: active puts the product on sale; archived takes it off.
  • --description <string>: The short description. An empty string clears it.
  • --cover-media-id <uuid|null>: The cover image's media id, or null to remove the cover.
  • --thank-you-url <string>: An absolute https url the buyer goes to after paying. An empty string clears it.
  • --settings <json>: The product page's selling content (description markdown, gallery_media_ids, bullets, testimonials, faq). Replaces the whole object, so read it first.
  • --license-config <json|null>
  • --service-config <json|null>
  • --dry-run: Print the request it would send, and for an update the fields that would change, without changing anything.

Permissions

Needs a key with the catalog:read and catalog:write permissions.

This command changes data. It can overwrite, archive or delete what is stored. Run it with --dry-run first to see what it would do.

On this page