Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa business

Manage Linked Device Business App resources.

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa business accounts view

View linked business accounts and ad identities.

Usage

polymorfa business accounts view [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business catalog cart set

Enable or disable the business catalog cart.

Usage

polymorfa business catalog cart set [flags]

Flags

  • --enabled <value>takes a valuerequired

    Whether the catalog cart is enabled.

    Allowed valuestruefalse
  • --idempotency-key <value>takes a value

    Safely identify retries of this cart update.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business catalog create

Create the connected account business catalog.

Usage

polymorfa business catalog create [flags]

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this catalog creation.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business catalog view

View a bounded page of a business catalog.

Usage

polymorfa business catalog view [flags]

Flags

  • --after <value>takes a value

    Opaque cursor returned by the preceding page.

  • --height <value>takes a value

    Requested image height.

  • --id <value>takes a valuerequired

    Polymorfa business user ID.

  • --limit <value>takes a value

    Maximum products to return.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --width <value>takes a value

    Requested image width.

Also accepts the global flags.

polymorfa business collection appeal

Appeal a rejected business collection.

Usage

polymorfa business collection appeal COLLECTION [flags]

Arguments

  • COLLECTIONrequired

    Business collection ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this collection appeal.

  • --reason <value>takes a valuerequired

    Appeal reason.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business collection create

Create a business collection.

Usage

polymorfa business collection create [flags]

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this collection creation.

  • --name <value>takes a valuerequired

    Collection name.

  • --product <value>takes a valuerequiredrepeatable

    Product ID. Repeat for each product in the collection.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business collection delete

Delete a business collection.

Usage

polymorfa business collection delete COLLECTION [flags]

Arguments

  • COLLECTIONrequired

    Business collection ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this collection deletion.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --yesbooleanrequired

    Confirm permanent collection deletion.

Also accepts the global flags.

polymorfa business collection list

List a bounded page of business collections.

Usage

polymorfa business collection list [flags]

Flags

  • --after <value>takes a value

    Opaque cursor returned by the preceding page.

  • --collection-limit <value>takes a value

    Maximum collections to return.

  • --height <value>takes a value

    Requested image height.

  • --id <value>takes a valuerequired

    Polymorfa business user ID.

  • --item-limit <value>takes a value

    Maximum products per collection.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --width <value>takes a value

    Requested image width.

Also accepts the global flags.

polymorfa business collection reorder

Reorder business collections from a JSON move list.

Usage

polymorfa business collection reorder [flags]

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this collection reorder.

  • --input <value>takes a valuerequired

    Read {"moves":[...]} from a file or standard input (-).

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business collection update

Update a business collection.

Usage

polymorfa business collection update COLLECTION [flags]

Arguments

  • COLLECTIONrequired

    Business collection ID.

Flags

  • --add-product <value>takes a valuerepeatable

    Product ID to add. Repeat for multiple products.

  • --idempotency-key <value>takes a value

    Safely identify retries of this collection update.

  • --name <value>takes a value

    Replacement collection name.

  • --remove-product <value>takes a valuerepeatable

    Product ID to remove. Repeat for multiple products.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business collection view

View one business collection and its bounded products.

Usage

polymorfa business collection view COLLECTION [flags]

Arguments

  • COLLECTIONrequired

    Business collection ID.

Flags

  • --after <value>takes a value

    Opaque product cursor accepted by the source.

  • --height <value>takes a value

    Requested image height.

  • --id <value>takes a valuerequired

    Polymorfa business user ID.

  • --limit <value>takes a value

    Maximum products to return.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --width <value>takes a value

    Requested image width.

Also accepts the global flags.

polymorfa business compliance replace

Replace complete business merchant compliance.

Usage

polymorfa business compliance replace [flags]

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this compliance replacement.

  • --input <value>takes a valuerequired

    Read the complete JSON compliance body from a file or standard input (-).

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business compliance view

View complete business merchant compliance.

Usage

polymorfa business compliance view [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business eligibility view

View business feature eligibility.

Usage

polymorfa business eligibility view [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business order view

Look up one business order using its event token.

Usage

polymorfa business order view ORDER [flags]

Arguments

  • ORDERrequired

    Business order ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this POST lookup.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --token <value>takes a valuerequired

    Exact order event token.

Also accepts the global flags.

polymorfa business product appeal

Appeal a rejected business product.

Usage

polymorfa business product appeal PRODUCT [flags]

Arguments

  • PRODUCTrequired

    Business product ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this product appeal.

  • --reason <value>takes a valuerequired

    Appeal reason.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business product create

Create a business product from a JSON document.

Usage

polymorfa business product create [flags]

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this product creation.

  • --input <value>takes a valuerequired

    Read the complete JSON product from a file or standard input (-).

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business product delete

Delete a business product.

Usage

polymorfa business product delete PRODUCT [flags]

Arguments

  • PRODUCTrequired

    Business product ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this product deletion.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --yesbooleanrequired

    Confirm permanent product deletion.

Also accepts the global flags.

polymorfa business product replace

Replace a business product from a JSON document.

Usage

polymorfa business product replace PRODUCT [flags]

Arguments

  • PRODUCTrequired

    Business product ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this product replacement.

  • --input <value>takes a valuerequired

    Read the complete JSON replacement from a file or standard input (-).

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business product view

View one business product.

Usage

polymorfa business product view PRODUCT [flags]

Arguments

  • PRODUCTrequired

    Business product ID.

Flags

  • --id <value>takes a valuerequired

    Polymorfa business user ID.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business product visibility set

Set whether a business product is hidden.

Usage

polymorfa business product visibility set PRODUCT [flags]

Arguments

  • PRODUCTrequired

    Business product ID.

Flags

  • --hidden <value>takes a valuerequired

    Whether the product is hidden.

    Allowed valuestruefalse
  • --idempotency-key <value>takes a value

    Safely identify retries of this visibility update.

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business profile cover delete

Delete the business profile cover photo.

Usage

polymorfa business profile cover delete COVER [flags]

Arguments

  • COVERrequired

    Business cover-photo ID.

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this cover-photo deletion.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --yesbooleanrequired

    Confirm permanent cover-photo deletion.

Also accepts the global flags.

polymorfa business profile cover set

Set the business profile cover photo.

Usage

polymorfa business profile cover set [flags]

Flags

  • --file <value>takes a value

    Local picture path. Sent as bounded base64 JSON.

  • --idempotency-key <value>takes a value

    Safely identify retries of this cover-photo update.

  • --session <value>takes a valuerequired

    Messaging session ID.

  • --url <value>takes a value

    Remote HTTP(S) picture URL fetched by the Messaging service.

Also accepts the global flags.

polymorfa business profile update

Update structured business profile fields.

Usage

polymorfa business profile update [flags]

Flags

  • --idempotency-key <value>takes a value

    Safely identify retries of this profile update.

  • --input <value>takes a valuerequired

    Read the complete JSON profile update from a file or standard input (-).

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.

polymorfa business profile view

View the connected account's own business profile.

Usage

polymorfa business profile view [flags]

Flags

  • --session <value>takes a valuerequired

    Messaging session ID.

Also accepts the global flags.