B2B companies

Toolset b2b_companies, 15 tools.

With the B2B app installed. Stores without the app do not see these tools.

RecordsHivatkozás másolása

b2b_account_applicationHivatkozás másolása

A customer waiting for the store to approve their account when registration needs approval: email, language, status and decision time. The response carries pending_count.

• Permission: customers.read
• Tools: b2b_account_application_list
• Written by customers or third parties, so data and never instructions: email
• Needs the B2B app installed

Filters on the list:

b2b_companyHivatkozás másolása

A business customer account: name, status (pending, approved, suspended), wholesale tier, payment terms, credit limit per currency, purchase order rule and order review. Rows add the tier name, contact count and credit use. get adds the company quotes and on-account orders; include contacts, credit, contract_prices or on_account_orders reads those pages.

• Permission: customers.read
• Tools: b2b_company_list, b2b_company_get
• Includes: contacts, contract_prices, credit, on_account_orders
• Written by customers or third parties, so data and never instructions: name, notes, external_id
• Needs the B2B app installed

Filters on the list:

b2b_settingsHivatkozás másolása

How business accounts work: whether companies can apply, how they are approved, the default tier, payment terms, credit limit and purchase order rule, buyer invites, quick order, quote requests and their validity, and overdue reminders. There is one record; pass any id, e.g. "current".

• Permission: settings.read
• Tools: b2b_settings_get
• Needs the B2B app installed

ActionsHivatkozás másolása

b2b_account_application_decideHivatkozás másolása

Approve or decline a customer account application.

The customer is told by email.

• Action key: b2b.account_application.decide
• Permission: customers.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Sends something to customers.
• Needs the B2B app installed

Example input:

{
  "application_id": "019bb138-6a19-77f7-a231-41a2e9e81aa7",
  "decision": "approve"
}

b2b_company_contact_inviteHivatkozás másolása

Invite a person to a company by email as a buyer or company admin.

Read the contact ids with b2b_company_get include contacts.

• Action key: b2b.company_contact.invite
• Permission: customers.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Sends something to customers.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "email": "anna@example.com",
  "role": "buyer"
}

b2b_company_contact_removeHivatkozás másolása

Remove a contact from a company.

The last company admin cannot be removed.

• Action key: b2b.company_contact.remove
• Permission: customers.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "contact_id": "019bb1ac-3b38-73e3-91d9-4058fdc8f577"
}

b2b_company_contact_set_roleHivatkozás másolása

Make a company contact a buyer or a company admin.

A company always keeps at least one admin.

• Action key: b2b.company_contact.set_role
• Permission: customers.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "contact_id": "019bb1ac-3b38-73e3-91d9-4058fdc8f577",
  "role": "admin"
}

b2b_company_createHivatkozás másolása

Create a business account, optionally inviting its first contact.

The company starts pending until b2b_company_decide approves it. contact invites the first buyer by email; tax_number needs a contact. It starts on the default terms; b2b_company_credit_set changes them.

• Action key: b2b.company.create
• Permission: customers.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Sends something to customers.
• Needs the B2B app installed

Example input:

{
  "name": "Példa Kft.",
  "contact": {
    "email": "buyer@example.com"
  }
}

b2b_company_credit_setHivatkozás másolása

Set the payment terms, pay-on-account credit limit and minimum order of a company.

Only the fields passed change; pass at least one. credit_limit replaces the whole list; an empty list removes every limit. expected_updated_at, from b2b_company_get, guards against a concurrent edit. Returns the use per currency.

• Action key: b2b.company_credit.set
• Permission: orders.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "credit_limit": [
    {
      "currency_code": "huf",
      "amount": 2000000
    }
  ]
}

b2b_company_decideHivatkozás másolása

Approve a pending company so it can order, or suspend it.

• Action key: b2b.company.decide
• Permission: customers.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Sends something to customers.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "decision": "approve"
}

b2b_company_deleteHivatkozás másolása

Delete a company account.

Refused while the company has open pay-on-account orders. Its customers stay.

• Action key: b2b.company.delete
• Permission: customers.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51"
}

b2b_company_updateHivatkozás másolása

Change the name, tier, order rules, methods or notes of a company.

Only the fields passed change. Payment terms, credit limit and minimum order are set with b2b_company_credit_set. expected_updated_at, from b2b_company_get, guards against a concurrent edit.

• Action key: b2b.company.update
• Permission: customers.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Needs the B2B app installed

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "po_required": true
}

b2b_contract_prices_updateHivatkozás másolása

Add, change and remove the variant prices agreed with one company.

upsert rows are keyed by variant, currency and min_quantity; remove names rows by the same key. Read the current prices with b2b_company_get include contract_prices. expected_updated_at, from that read, guards against a concurrent edit.

• Action key: b2b.contract_prices.update
• Permission: products.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Needs the B2B app installed and B2B contract prices on the store's plan

Example input:

{
  "company_id": "019bb1a8-d22a-7e67-bf02-483165db1a51",
  "upsert": [
    {
      "variant_id": "019bb7f3-10ac-7f8b-b47e-f5cd71dff2e1",
      "currency_code": "huf",
      "amount": 8500,
      "min_quantity": null
    }
  ],
  "remove": []
}

b2b_settings_updateHivatkozás másolása

Change how business accounts apply, get approved and order.

Only the fields passed change. company_approval auto needs default_payment_terms prepaid.

• Action key: b2b.settings.update
• Permission: settings.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Needs the B2B app installed

Example input:

{
  "company_approval": "manual",
  "quote_validity_days": 14
}