Product Order Open API

api_version

Optional. Version of the endpoint to access. For example, v1 or v2. Only specify this value to use an endpoint version other than the latest. Data type: String

account

Filter product orders by the associated account. Use this to retrieve all orders for a specific customer account or business unit.Data type: String

consumer (relatedParty)

Filter product orders by the consumer or end-user. Use this to retrieve orders for a specific consumer within a customer account, useful in multi-party or wholesale scenarios.Data type: String

contact

Filter product orders by an associated contact. Use this to find all orders linked to a specific person (like order coordinator, and billing contact).Data type: String

externalId

Filter product orders by external identifier. Use this to locate orders using identifiers from external systems or legacy integrations (like legacy order numbers, or third-party reference IDs).Data type: String

fields

List of fields to return in the response. Invalid fields are ignored. Data type: String

Default: All fields returned.

limit

Maximum number of records to return. For requests that exceed this number of records, use the offset parameter to paginate record retrieval. Data type: Number

Default: 20

Maximum: 100

offset

Starting index at which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks.Data type: Number

Default: 0

state

Filter orders by state. Only orders with a state matching the value of this parameter are returned in the response.Data type: String

Default: Don't order by state.

Content-Range

Range of content returned in a paginated call. For example, if offset=2 and limit=3, the value of the Content-Range header is items 3-5.

Content-Type

Data format of the response body. Only supports application/json.

Link

Contains the following links to navigate through query results.- first

• last
• next
• previous

X-Total-Count

For paginated queries, this header specifies the total number of records available on the server.

200

Request successfully processed. Full resource returned in response (no pagination).

206

Partial resource returned in response (with pagination).

400

Bad request. Possible reasons:

• Invalid path parameter
• Invalid URI

404

Record not found. No records matching the query parameters are found in the table.

@type

Part of TMF Open API standard. Annotation for the product. This value is always ProductOrder. This information is not stored.Data type: String

channel

List of channels to use for selling the products.Stored in: sn_ind_tmt_orm_order

Data type: Array of Objects

"channel": [  {    "id": "String",    "name": "String"  }]

channel.id

Required. Unique identifier of the channel to use to sell the associated products.Data type: String

Stored in: The channel field of the sn_ind_tmt_orm_order table.

channel.name

Name of the channel to use to sell the associated products.Possible channel names are defined on the list tab in the Channel Dictionary Entry of the sn_ind_tmt_orm_order table.

Data type: String

committedDueDate

Date and time when the action must be performed on the order.Stored in: committed_due_date field of the sn_ind_tmt_orm_order table.

Format: ISO 8601 (Example: 2021-05-02T08:13:59.506Z)

Data type: String

externalId

External identifier for the customer order, such as a purchase order number. This value is determined by an external system. Stored in: external_id field of the sn_ind_tmt_orm_order table.

Data type: String

externalSystem

External system identifier that originated the order request, appended with TMF622. Data Type: String

href

Relative link to the resource record.Data type: String

note

Additional notes made by the customer when ordering. Stored in: sn_ind_tmt_orm_order

Data type: Array of Objects

"note": [  {    "text": "String"  }]

note.text

Additional notes/comments made by the customer while ordering.Stored in: The comments field of the sn_ind_tmt_orm_order table.

Data type: String

orderCurrency

Currency code for the order and order line items.Data type: String

orderDate

Date and time when the order was created.Data type: String

Format: ISO 8601 (Example: 2021-05-02T08:13:59.506Z)

orderId

Sys_id of the order.Stored in the Inbound Queue [sn_tmt_core_inbound_queue] table on a schedule to be processed.

Data type: String

productOrderItem

Items associated with the product order and their associated action. Data type: Array of Objects

"productOrderItem": [  {    "action": "String",    "actionReason": "String",    "billingAccount": {Object},    "committedDueDate": "String",    "externalProductInventory": [Array],    "id": "String",    "itemPrice": [Array],    "payment": {Object},    "product": {Object},    "productOffering": {Object},    "productOrderItemRelationship": [Array],    "quantity": Number,    "@type": "String"  }]

Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

productOrderItem.@type

Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem. This information is not stored.Data type: String

productOrderItem.action

Required. Action to carry out on the product. Possible actions are defined on the list tab in the Action Dictionary Entry of the sn_ind_tmt_orm_order_line_item table. Possible values:

• add
• change

Note: Submitting a change payload that includes a new service location via productOrderItem.product.place.id is processed as a move order.

• delete
• no-change
• resume
• suspend

Data type: String

Stored in: The action field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.actionReason

Optional. Description of the reason for the order line item.Data type: String

Stored in: The action_reason field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.billingAccount

Required. Identifies the billing account and determines how the account is processed.- When an existing billing account ID is passed, the API returns just the matching account's sys_id and type.

• When a billing account ID is passed that doesn't match an existing record, the API creates a new billing account with the provided ID as the external_id. The object includes conditional attributes associated with the new record.

Data type: Object

Example reference structure:

"billingAccount": {          "id": "sys_id_billing_account_456",          "@type": "BillingAccountRef"        }

Example creation structure:

"billingAccount": {          "id": "billingID",          "name": "Project 1234 Billing",          "@type": "BillingAccountRef",          "status": "Active",          "active": true        }

productOrderItem.billingAccount.@type

Conditional, required only for account creation. Must always be BillingAccountRef. This indicates that the object is a reference to a billing account record.Data type: String

productOrderItem.billingAccount.active

Conditional, required only for account creation. Flag that indicates whether the billing account is active. This field is used when creating a new billing account, and is ignored when referencing an existing billing account.

Valid values:

• true: Billing account is active.
• false: Billing account isn't active.

Default: If not provided during creation, the system uses the default active value configured in your instance

productOrderItem.billingAccount.id

Required. Sys_id or external_id of the billing account to reference or create inline.Data type: String

productOrderItem.billingAccount.name

Conditional, required only for account creation. Display name of the billing account. This field is used when creating a new billing account. If not provided during creation, the system uses a default name pattern. This field is ignored when referencing an existing billing account.

Example: "Main Office Billing", "Project 2024 Billing"

Data type: String

productOrderItem.billingAccount.status

Conditional, required only for account creation. The status of the billing account. This field is used when creating a new billing account. Valid values depend on your instance configuration. If not provided during creation, the system uses the default status value configured in your instance. This field is ignored when referencing an existing billing account.

Example: "Active", "Inactive", "Suspended"

Data type: String

productOrderItem.committedDueDate

Optional. Date and time when the action must be performed on the order line item.

Data type: String

Format: ISO 8601 (Example: 2021-05-02T08:13:59.506Z)

Stored in: The committed_due_date field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.externalProductInventory.externalProductInventoryId

External ID to map to the product inventory.Data type: String

Stored in: The external_inventory_id field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table and the sn_prd_invt_external_id field of the sn_prd_invt_product_inventory table.

productOrderItem.externalProductInventory

Conditional. If supplied, each entry requires externalProductInventoryId. External IDs to map to the product inventories created for the order.Data type: Array of Objects

"externalProductInventory": [  {    "externalProductInventoryId": "String"  }]

productOrderItem.id

Required. Unique identifier of the line item. Data type: String

Stored in: The external_id field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

Maximum length: 40

Default: empty string

productOrderItem.itemPrice

Price associated with the product. Data type: Array of Objects

"itemPrice": [  {    "price": {Object},    "priceType": "String",    "recurringChargePeriod": "String"  }]

Stored in: sn_ind_tmt_orm_order

Default: empty string

productOrderItem.itemPrice.price

Description of the price of the associated product. Data type: Object

"price": {  "taxIncludedAmount": {Object}}

Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Default: empty string

productOrderItem.itemPrice.price.taxIncludedAmount

Description of the price of the associated product, including the tax. Data type: Object

"taxIncludedAmount": {  "unit": "String",  "value": Number}

Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

productOrderItem.itemPrice.price.taxIncludedAmount.unit

Currency code in which the price is expressed. Data type: String

Stored in: The mrc or nrc field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table

productOrderItem.itemPrice.price.taxIncludedAmount.value

Price of product, including any tax. Data type: Number

Stored in: The mrc or nrc field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table

productOrderItem.itemPrice.priceType

Specifies whether the price of the item is recurring or non-recurring. Data type: String

productOrderItem.itemPrice.recurringChargePeriod

If the price is recurring, the recurring period, such as month. Data type: String

productOrderItem.payment

Required. Identifies the payment profile. - If the passed profile ID already exists, the API returns just the matching payment profile's sys_Id.

• If the passed ID doesn't already exist, the API returns the new payment profile's sys_id and associated attributes.

Data type: Object

Reference structure:

"payment": {  "id": "String"}

Creation structure:

"payment": {  "id": "String",  "paymentMethod": "String",  "paymentMethodType": "String",  "paymentReferenceId": "String"}

See the 'Examples' section for POST requests demonstrating both reference and creation patterns.

productOrderItem.payment.id

Sys_id or external_id of an existing payment profile record.Data type: String

productOrderItem.payment.paymentMethod

Returned only for profile creation. A choice field representing the payment method category. This field is validated against configured payment method choices in your instance. This field is ignored when referencing an existing profile.Example: "Credit Card", "Bank Transfer", "Check", "Digital Wallet"

Data type: String

productOrderItem.payment.paymentMethodType

Returned only for profile creation. A choice field representing the specific payment method type.Example: Visa", "MasterCard", "American Express" for credit cards; "ACH" or "Wire" for bank transfers

Data type: String

productOrderItem.payment.paymentReferenceId

Returned only for profile creation. An external reference identifier for the payment profile.Example: "REF-2024-001", "CARD-XXXX-5678"

Data type: String

productOrderItem.product

Instance details of the product purchased by the customer.Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Data type: Object

"product": {  "id": "String",  "place": {Object},  "productCharacteristic": [Array],  "productSpecification": {Object},  "relatedParty": {Object},  "@type": "String"}

productOrderItem.product.@type

Part of TMF Open API standard. Annotation for the product. This value is always Product.Data type: String

productOrderItem.product.id

Unique identifier of the product sold. Data type: String

Table: In the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory [sn_ind_tmt_orm_product_inventory] table.

productOrderItem.product.place

Maps of the locations on which to install the product. Data type: Object

"place": {  "id": "String",  "@type": "String"}

Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

productOrderItem.product.place.@type

Part of TMF Open API standard. Annotation for order line item contact. This value is always Place.Data type: String

productOrderItem.product.place.id

Required. Sys_id of the associated location record.Data type: String

Table: Location [cmn_location]

Stored in: The location field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.product.productCharacteristic

Characteristics of the associated product.Stored in: sn_ind_tmt_orm_order_characteristic_value

Data type: Array of Objects

"productCharacteristic": [  {  "name": "String",  "previousValue": "String",  "value": "String",  "valueType": "String" }]

productOrderItem.product.productCharacteristic.name

Name of the characteristic record to associated with the product.Data type: String

Table: Characteristic [sn_prd_pm_characteristic]

Stored in: The characteristics field of the sn_ind_tmt_orm_order_characteristic_value table.

productOrderItem.product.productCharacteristic.previousValue

Previous characteristic option values if the update is for change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see Create product characteristics and characteristic options. Data type: String

Stored in: The previous_characteristic_option_value field of the sn_ind_tmt_orm_order_characteristic_value table.

Default: empty string

productOrderItem.product.productCharacteristic.value

Characteristic option values associated with the product. For additional information on characteristic option values, see Create product characteristics and characteristic options. Data type: String

Stored in: The characteristic_option_value field of the sn_ind_tmt_orm_order_characteristic_value table.

Default: empty string

productOrderItem.product.productCharacteristic.valueType

Type of characteristic value.Accepted values:

• address
• array.date
• array.datetime
• array.decimal
• array.integer
• array.object
• array.single_line_text
• attachment
• checkbox
• choice
• date
• date_time
• decimal
• duration
• email
• integer
• object
• single_line_text
• yes_no

Data type: String

productOrderItem.product.productSpecification

Description of the product specification associated with the product. Note: Change orders (productOrderItem.action is change) are processed differently based on the value of the sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder system property. The value of this system property determines how the order is processed if the product inventory is a different version than indicated in the order.

• true: Product inventory is automatically upgraded to the version in the order by changing the referenced product specification. This allows the order to be successfully processed.
• false: If the product inventory is a different version than indicated in the order, the order fails due to the version mismatch.

Data type: Object

"productSpecification": {  "id": "String",  "internalVersion": "String",  "name": "String",  "version": "String",  "@type": "String"}

Stored in: sn_ind_tmt_orm_order_line_item

productOrderItem.product.productSpecification.@type

Part of the TMF Open API standard. This value is always ProductSpecificationRef. This information is not stored. Data type: String

productOrderItem.product.productSpecification.id

Required. Initial version or external ID of the product specification. The initial version is the sys_id of the first version of the specification.Data type: String

Table: Product Specification [sn_prd_pm_product_specification]

productOrderItem.product.productSpecification.internalVersion

Internal version of the service specification. Must match the value of version otherwise an error is thrown.Data Type: String

Table: In the version field of the Product Specification [sn_prd_pm_product_specification] table.

productOrderItem.product.productSpecification.name

Name of the product specification. Data type: String

Table: Product Specification [sn_prd_pm_product_specification]

productOrderItem.product.productSpecification.version

External version of the service specification. Must match the value of internalVersion otherwise an error is thrown.Data Type: String

Table: In the external_version field of the Product Specification [sn_prd_pm_product_specification] table.

productOrderItem.product.relatedParty

List of party roles linked to an OrderLineItemContact. Data type: Array of Objects

"relatedParty": [  {    "email": "String",    "firstName": "String",    "lastName": "String",    "phone": "String",    "@referredType": "String",    "@type": "String"  }]

Stored in: sn_ind_tmt_orm_order_line_item_contact

productOrderItem.product.relatedParty.@referredType

Required. Type of customer. Possible value: OrderLineItemContact

Data type: String

productOrderItem.product.relatedParty.@type

Part of TMF Open API standard. Annotation for order line item contact. This value is always RelatedParty. This information is not stored. Data type: String

productOrderItem.product.relatedParty.email

Email address of the contact. Data type: String

Stored in: The email field of the sn_ind_tmt_orm_order_line_item_contact table.

Default: empty string

productOrderItem.product.relatedParty.firstName

First name of the contact. Data type: String

Stored in: The first_name field of the sn_ind_tmt_orm_order_line_item_contact table.

Default: empty string

productOrderItem.product.relatedParty.lastName

Last name of the contact. Data type: String

Stored in: The lastName field of the sn_ind_tmt_orm_order_line_item_contact table.

Default: empty string

productOrderItem.product.relatedParty.phone

Business phone number of the contact. Data type: String

Stored in: The business_phone field of the sn_ind_tmt_orm_order_line_item_contact table.

Default: empty string

productOrderItem.productOffering

Required. Description of the product offering associated with the product. Data type: Object

"productOffering": {  "id": "String",  "internalVersion": "String",  "name": "String",  "version": "String"}

Stored in: sn_ind_tmt_orm_order_line_item

productOrderItem.productOffering.id

Required. Initial version or external ID of the product offering. The initial version is the sys_id of the first version of the offering.Data type: String

Table: Product Offering [sn_prd_pm_product_offering]

productOrderItem.productOffering.internalVersion

Version of the product offering.Data type: String

Table: In the version field of the Product Offering [sn_prd_pm_product_offering] table.

productOrderItem.productOffering.name

Name of the product offering.Data type: String

Table: Product Offering [sn_prd_pm_product_offering]

productOrderItem.productOffering.version

External version of the product offering.Data type: String

Table: In the external_version field of the Product Offering [sn_prd_pm_product_offering] table.

productOrderItem.productOrderItem.quantity

Number of the associated items to order. Data type: Number

Stored in: The quantity field of the sn_ind_tmt_orm_order table.

Default: null

productOrderItem.productOrderItemRelationship

List that describes the parent/child relationship between order items. Data type: Array of Objects

"productOrderItemRelationship": [  {    "id": "String",    "relationshipType": "String"  }]

Stored in: sn_ind_tmt_orm_order_line_item

productOrderItem.productOrderItemRelationship.id

Same as the productOrderItem.id value. Used for parent/child relationship Data type: String

Stored in: The parent_line_item field of the sn_ind_tmt_orm_order_line_item table.

Default: empty string

productOrderItem.productOrderItemRelationship.relationshipType

Type of relationship between the two line items. This information is used to identify relationship hierarchy. Possible values:

• HasChild
• HasParent

Data type: String

productOrderItem.quantity

Number of items ordered.Data type: Number

Stored in: The quantity field of the sn_ind_tmt_orm_order table.

Default: empty string

relatedParty

List of contacts for the order containing customer account or consumer account information. Supports reference and inline creation patterns (Account, Contact, Location). Data type: Array of Objects

"relatedParty": [ {  "role": "String",  "@type": "String",  "partyOrPartyRole": {Object} }]

realtedParty.role

Business role that the referenced party plays in the order context. Matches the relatedParty.@type value.Possible values:

• Account
• Contact
• Customer
• Location

Data type: String

relatedParty.@type

Record type of the party. Matches the relatedParty.role value.Data type: String

relatedParty.partyOrPartyRole

Object containing the specific reference details about the party.- If the passed ID already exists, the API returns just the @type and id fields of the matching party.

• If the passed ID doesn't already exist, the API returns a the new Account, Contact, or Location ID with its conditional attributes, which vary based on the @type value.

Data type: Object

Reference pattern:

"partyOrPartyRole": {  "@type": "PartyRef",  "id": "String"}

Account creation:

"partyOrPartyRole": {  "@type": "PartyRef",  "id": "String",  "accountNumber": "String",  "status": "String"}

Contact creation:

"partyOrPartyRole": {  "@type": "PartyRef",  "id": "String",  "firstName": "String",  "lastName": "String",  "email": "String" }

Location creation:

"partyOrPartyRole": {  "@type": "PartyRef",  "id": "String",  "name": "String",  "address": "String",  "city": "String",  "postalCode": "String",  "country": "String" }

relatedParty.partyOrPartyRole.@type

Indicates the type of reference being provided. Value is always PartyRef.Data type: String

relatedParty.partyOrPartyRole.accountNumber

Returned for Account party types. External reference number or identifier for the Account.Data type: String

relatedParty.partyOrPartyRole.address

Returned for Location party types. Street address of the location.Example: "123 Main Street"

Data type: String

relatedParty.partyOrPartyRole.city

Returned for Location party types. City or municipality name for the location.Example: "San Francisco", "New York"

Data type: String

relatedParty.partyOrPartyRole.country

Returned for Location party types. Country where the location is physically situated or where the contact is based.Data type: String

relatedParty.partyOrPartyRole.email

Returned for Contact party types. Contact person's primary email address.Data type: String

relatedParty.partyOrPartyRole.firstName

Returned for Contact party types. Contact person's first name or given name.Data type: String

relatedParty.partyOrPartyRole.id

Sys_id or external_id of the party record.Data type: String

Table: Account [customer_account], Contact [customer_contact] table, or Location [location]

relatedParty.partyOrPartyRole.lastName

Returned for Contact party types. Contact person's last name or given name.Data type: String

relatedParty.partyOrPartyRole.name

Returned for Account, Contact, and Location types. Name of the account, contact, or location. Data type: String

relatedParty.partyOrPartyRole.postalCode

Required for Location party types. Postal code, ZIP code, or PIN code for the location.Data type: String

relatedParty.partyOrPartyRole.status

Returned for Account party types. Current status of the account. Possible values for the status field depend on how your instance is configured.Common values include:

• Active: Account is in normal operation
• Inactive: Account is not currently conducting business
• Suspended: Account is temporarily restricted
• Pending: Account is awaiting activation
• Archived: Historical accounts
• Under Review: Account is being evaluated

Data type: String

relatedParty.role

Business role that the referenced party plays in the order context. Matches the relatedParty.@type value.Possible values:

• Account: parties representing a customer or business entity
• Contact: parties representing a contact person
• Customer: parties representing an end consumer or individual
• Location: parties representing a service address or fulfillment location

Data type: String

requestedCompletionDate

Delivery date requested by the customer. Data type: String

Format: ISO 8601 (Example: 2021-05-02T08:13:59.506Z)

Stored in: expected_end_date field of the sn_ind_tmt_orm_order table.

requestedStartDate

Order start date requested by the customer. Data type: String

Format: ISO 8601 (Example: 2021-05-02T08:13:59.506Z)

Stored in: expected_start_date field of the sn_ind_tmt_orm_order table.

state

Current state of the order.Data type: String

productOrderItem

Items associated with the product order and their associated action.Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Data type: Array of Objects

"productOrderItem": [  {    "action": "String",    "actionReason": "String",    "billingAccount": {Object},    "committedDueDate": "String",    "externalProductInventory": [Array],    "id": "String",    "itemPrice": [Array],    "payment": {Object},    "product": {Object},    "productOffering": {Object},    "productOrderItemRelationship": [Array],    "quantity": Number,    "@type": "String"  }]

productOrderItem.@type

Part of TMF Open API standard. Annotation for the product. This value is always ProductOrderItem.Data type: String

productOrderItem.action

Action carried out on the product.Possible values:

• add
• change
• delete
• no-change
• resume
• suspend

Data type: String

Stored in: action field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.actionReason

Description of the reason for the order line item.Data type: String

Stored in: action_reason field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.billingAccount

Identifies the billing account and determines how the account is processed.- When you provide a billing.id that matches an existing billing account, the API uses the reference pattern to link the account to the order line item. Other billing account fields you include (name, status, active) are ignored. The system uses only the ID to find and link the existing billing account.

• When you provide a billing.id that doesn't match an existing billing account, the API creates a new billing account with the provided ID as the external_id. Billing account fields (name, status, active) are required.

Data type: Object

Reference structure:

"billingAccount": {          "id": "sys_id_billing_account_456",          "@type": "BillingAccountRef"        }

Creation structure:

"billingAccount": {          "id": "billingID",          "name": "Project 1234 Billing",          "@type": "BillingAccountRef",          "status": "Active",          "active": true        }

productOrderItem.billingAccount.@type

Returned for account creation. Must always be BillingAccountRef. This indicates that the object is a reference to a billing account record.Data type: String

productOrderItem.billingAccount.active

Returned only for account creation. Flag that indicates whether the billing account is active. This field is used when creating a new billing account, and is ignored when referencing an existing billing account.

Valid values:

• true: Billing account is active.
• false: Billing account isn't active.

productOrderItem.billingAccount.id

Sys_id or external_id of the billing account to reference or create inline.Data type: String

productOrderItem.billingAccount.name

Returned for account creation. Display name of the billing account.Example: "Main Office Billing", "Project 2024 Billing"

Data type: String

productOrderItem.billingAccount.status

Returned for account creation. The status of the billing account. Possible values depend on your instance configuration. Example: "Active", "Inactive", "Suspended"

Data type: String

productOrderItem.committedDueDate

Date and time when the action must be performed on the order line item.Data type: String

Format: ISO 8601 (Example: 2021-05-02T08:13:59.506Z)

Stored in: The committed_due_date field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

productOrderItem.externalProductInventory.externalProductInventoryId

External ID to map to the product inventory.Data type: String

Stored in: The external_inventory_id field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table and the sn_prd_invt_external_id field of the sn_prd_invt_product_inventory table.

productOrderItem.externalProductInventory

External IDs which map to the product inventories created for the order.Data type: Array of Objects

"externalProductInventory": [  {    "externalProductInventoryId": "String"  }]

productOrderItem.id

Required. Unique identifier of the line item. Stored in: The external_id field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

Data type: String

productOrderItem.itemPrice

Price associated with the product. Stored in: sn_ind_tmt_orm_order

Data type: Array of Objects

"itemPrice": [  {    "price": {Object},    "priceType": "String",    "recurringChargePeriod": "String"  }]

productOrderItem.itemPrice.price

Description of the price of the associated product. Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Data type: Object

"price": {  "taxIncludedAmount": {Object}}

productOrderItem.itemPrice.price.taxIncludedAmount

Description of the price of the associated product, including the tax. Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Data type: Object

"taxIncludedAmount": {  "unit": "String",  "value": Number}

productOrderItem.itemPrice.price.taxIncludedAmount.unit

Currency code in which the price is expressed.Stored in: The mrc or nrc field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table

Data type: String

productOrderItem.itemPrice.price.taxIncludedAmount.value

Price of product, including any tax. Stored in: The mrc or nrc field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table

Data type: Number

productOrderItem.itemPrice.priceType

Specifies whether the price of the item is recurring or non-recurring. Data type: String

productOrderItem.itemPrice.recurringChargePeriod

If the price is recurring, the recurring period, such as month. Data type: String

productOrderItem.payment

Details about the payment profile.Data type: Object

"payment": {  "id": "String",  "paymentMethod": "String",  "paymentMethodType": "String",  "paymentReferenceId": "String"}

productOrderItem.payment.id

Sys_id or external_id of an existing payment profile record.Data type: String

productOrderItem.payment.paymentMethod

Returned for profile creation. A choice field representing the payment method category. This field is validated against configured payment method choices in your instance.Example: "Credit Card", "Bank Transfer", "Check", "Digital Wallet"

Data type: String

productOrderItem.payment.paymentMethodType

Returned for profile creation. A choice field representing the specific payment method type. This field is validated against configured payment method type choices and is typically dependent on the selected paymentMethod.Example: Visa", "MasterCard", "American Express" for credit cards; "ACH" or "Wire" for bank transfers

Data type: String

productOrderItem.payment.paymentReferenceId

Returned for profile creation. External reference identifier for the payment profile.Example: "REF-2024-001", "CARD-XXXX-5678"

Data type: String

productOrderItem.product

Returned if productOrderItem.action is change or delete. Instance details of the product purchased by the customer.Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Data type: Object

"product": {  "id": "String",  "place": {Object},  "productCharacteristic": [Array],  "productSpecification": {Object},  "relatedParty": {Object},  "@type": "String"}

productOrderItem.product.@type

Part of TMF Open API standard. Annotation for the product. This value is always Product.Data type: String

productOrderItem.product.id

Returned if productOrderItem.action is change or delete. Unique identifier of the product sold. Table: In the sys_id or sn_ind_tmt_orm_external_id field of the Product Inventory [sn_ind_tmt_orm_product_inventory] table.

Data type: String

productOrderItem.product.place

Maps of the locations on which to install the product. Stored in: Order Line Item [sn_ind_tmt_orm_order_line_item]

Data type: Object

"place": {  "id": "String",  "@type": "String"}

productOrderItem.product.place.@type

Part of TMF Open API standard. Annotation for order line item contact. This value is always Place.Data type: String

productOrderItem.product.place.id

Sys_id of the associated location record. Table: Location [cmn_location]

Stored in: The location field of the Order Line Item [sn_ind_tmt_orm_order_line_item] table.

Data type: String

productOrderItem.product.productCharacteristic

Characteristics of the associated product. Stored in: sn_ind_tmt_orm_order_characteristic_value

Data type: Array of Objects

"productCharacteristic": [  {  "name": "String",  "previousValue": "String",  "value": "String",  "valueType": "String" }]

productOrderItem.product.productCharacteristic.name

Name of the characteristic record to associated with the product.Data type: String

Table: Characteristic [sn_prd_pm_characteristic]

Stored in: The characteristics field of the sn_ind_tmt_orm_order_characteristic_value table.

productOrderItem.product.productCharacteristic.previousValue

Previous characteristic option values if the update is for change order. The request is a change order if the productOrderItem.action parameter is other than add. For additional information on characteristic option values, see Create product characteristics and characteristic options. Data type: String

Stored in: The previous_characteristic_option_value field of the sn_ind_tmt_orm_order_characteristic_value table.

productOrderItem.product.productCharacteristic.value

Characteristic option values associated with the product. For additional information on characteristic option values, see Create product characteristics and characteristic options. Data type: String

Stored in: The characteristic_option_value field of the sn_ind_tmt_orm_order_characteristic_value table.

productOrderItem.product.productCharacteristic.valueType

Type of characteristic value.Accepted values:

• address
• array.date
• array.datetime
• array.decimal
• array.integer
• array.object
• array.single_line_text
• attachment
• checkbox
• choice
• date
• date_time
• decimal
• duration
• email
• integer
• object
• single_line_text
• yes_no

Data type: String

productOrderItem.product.productSpecification

Specification details associated with the product. Stored in: sn_ind_tmt_orm_order_line_item

Data type: Object

"productSpecification": {  "id": "String",  "internalVersion": "String",  "name": "String",  "version": "String",  "@type": "String"}

productOrderItem.product.productSpecification.@type

Part of the TMF Open API standard. This value is always ProductSpecificationRef.Data type: String

productOrderItem.product.productSpecification.id

Initial version or external ID of the product specification. The initial version is the sys_id of the first version of the specification.Data type: String

Table: Product Specification [sn_prd_pm_product_specification]

productOrderItem.product.productSpecification.internalVersion

Internal version of the service specification. Matches the value of version.Data Type: String

Table: In the version field of the Product Specification [sn_prd_pm_product_specification] table.

productOrderItem.product.productSpecification.name

Name of the product specification. Data type: String

Table: Product Specification [sn_prd_pm_product_specification]

productOrderItem.product.productSpecification.version

External version of the service specification. Matches the value of internalVersion.Data Type: String

Table: In the external_version field of the Product Specification [sn_prd_pm_product_specification] table.

productOrderItem.product.relatedParty

List of party roles linked to an Order Line Item Contact. Stored in: sn_ind_tmt_orm_order_line_item_contact

Data type: Array of Objects

"relatedParty": [  {    "email": "String",    "firstName": "String",    "lastName": "String",    "phone": "String",    "@referredType": "String",    "@type": "String"  }]

productOrderItem.product.relatedParty.@referredType

Required. Type of customer. Possible value: OrderLineItemContact

Data type: String

productOrderItem.product.relatedParty.@type

Part of TMF Open API standard. Annotation for order line item contact. This value is always RelatedParty.Data type: String

productOrderItem.product.relatedParty.email

Email address of the contact. Stored in: The email field of the sn_ind_tmt_orm_order_line_item_contact table.

Data type: String

productOrderItem.product.relatedParty.firstName

First name of the contact.Stored in: The first_name field of the sn_ind_tmt_orm_order_line_item_contact table.

Data type: String

productOrderItem.product.relatedParty.lastName

Last name of the contact.Stored in: The lastName field of the sn_ind_tmt_orm_order_line_item_contact table.

Data type: String

productOrderItem.product.relatedParty.phone

Business phone number of the contact. Stored in: The business_phone field of the sn_ind_tmt_orm_order_line_item_contact table.

Data type: String

productOrderItem.productOffering

Details of the product offering associated with the product.Stored in: sn_ind_tmt_orm_order_line_item

Data type: Object

"productOffering": {  "id": "String",  "internalVersion": "String",  "name": "String",  "version": "String"}

productOrderItem.productOffering.id

Initial version or external ID of the product offering. The initial version is the sys_id of the first version of the offering.Table: Product Offering [sn_prd_pm_product_offering]

Data type: String

productOrderItem.productOffering.internalVersion

Version of the product offering.Data type: String

Table: In the version field of the Product Offering [sn_prd_pm_product_offering] table.

productOrderItem.productOffering.name

Name of the product offering.Data type: String

Table: Product Offering [sn_prd_pm_product_offering]

productOrderItem.productOffering.version

External version of the product offering.Data type: String

Table: In the external_version field of the Product Offering [sn_prd_pm_product_offering] table.

productOrderItem.productOrderItem.quantity

Number of the associated items to order. Stored in: The quantity field of the sn_ind_tmt_orm_order table.

Data type: Number

productOrderItem.productOrderItemRelationship

Required. List that describes the parent/child relationship between order items. Data type: Array of Objects

"productOrderItemRelationship": [  {    "id": "String",    "relationshipType": "String"  }]

Stored in: sn_ind_tmt_orm_order_line_item

productOrderItem.productOrderItemRelationship.id

Same as the productOrderItem.id value. Used for parent/child relationship Stored in: The parent_line_item field of the sn_ind_tmt_orm_order_line_item table.

Data type: String

productOrderItem.productOrderItemRelationship.relationshipType

Type of relationship between the two line items. This information is used to identify relationship hierarchy. Possible values:

• HasChild
• HasParent

Data type: String

productOrderItem.quantity

Number of items ordered.Data type: Number

Stored in: The quantity field of the sn_ind_tmt_orm_order table.