commerce/customer/accounts/purchaseOrder

Use the Customer Account Purchase Order resource to manage purchase order details for specific customer acocunts.

JSON Example

CustomerPurchaseOrderAccount Properties

Property Description
accountId

type: int

Unique identifier of the customer account generated by the system. Account IDs are generated at account creation.

availableBalance

type: decimal

The available balance the customer has on their purchase order account. This balance is the result of the creditLimit minus the customer's total amount due.

creditLimit

type: decimal

The total credit limit the customer can spend using purchase orders.

customerPurchaseOrderPaymentTerms

type: list of customerPurchaseOrderPaymentTerm

The specific payment terms for the customer's purchase order account. Each payment term is associated with a specific site, and you can specify more than one payment term for each site.

customerPurchaseOrderPaymentTerm.code

type: string

The unique identifier of the object.

customerPurchaseOrderPaymentTerm.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

customerPurchaseOrderPaymentTerm.siteId

type: int

Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.

id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

isEnabled

type: bool

Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order.

overdraftAllowance

type: decimal

The total monetary amount the customer can spend over their purchase order creditLimit. The overdraftAllowanceType controls the units of this amount.

overdraftAllowanceType

type: string

Specifies the type and units of the overdraftAllowance amount.

The valid values are:

  • Amount — specifies that the overdraftAllowance amount is a decimal amount.
  • Percent — specifies that the overdraftAllowance amount is a percentage amount.

totalAvailableBalance

type: decimal

The total available balance the customer has on their purchase order account. This balance is the result of the availableBalance minus the overdraftAllowance.

Operations

Operation Name Request URI Description
CreateCustomerPurchaseOrderAccount POST %7baccountId%7d%2fpurchaseOrderAccount%3fresponseFields%3d%7bresponseFields%7d

Adds a purchase order account to the specified customer account.

This adds the ability for the specified customer account to use the purchase order payment method.

CreatePurchaseOrderTransaction POST %7baccountId%7d%2fPurchaseOrderTransaction%3fresponseFields%3d%7bresponseFields%7d

Creates a purchase order transaction on the specified customer purchase order account.

DeleteCustomerPurchaseOrderAccount DELETE internal%2f%7baccountId%7d%2fpurchaseOrderAccount

Deletes the specified customer purchase order account.

This removes the ability for the specified customer account to use the purchase order payment method.

GetCustomerPurchaseOrderAccount GET %7baccountId%7d%2fpurchaseOrderAccount%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified customer purchase order account.

GetCustomerPurchaseOrderTransactions GET %7baccountId%7d%2fPurchaseOrderTransaction%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of purchase order transactions for the specified customer account according to any specified sort options.

UpdateCustomerPurchaseOrderAccount PUT %7baccountId%7d%2fpurchaseOrderAccount%3fresponseFields%3d%7bresponseFields%7d

Updates the details of the purchase order account for the specified customer account.