제품 주문 오픈 API
Product Order Open API는 제품 주문을 위한 표준화된 메커니즘을 제공합니다.
제품 주문은 제품 카탈로그에 정의되고 게시된 제품 오퍼링을 기반으로 생성됩니다. 제품 오퍼링은 고객에게 제공되는 제품 또는 제품 세트를 식별하고, 제품의 고유한 옵션을 포착하는 관련 제품 특성과 가격 책정, 계약 조건 및 가용성과 같은 기타 관련 속성을 포함합니다.
이 API에 접근하려면 Order Management for Telecommunications(sn_ind_tmt_orm) 플러그인을 활성화해야 합니다.
이 API는 sn_ind_tmt_orm 네임스페이스 내에서 제공됩니다.
호출하는 사용자에게는 sn_ind_tmt_orm.order_integrator 역할이 있어야 합니다.
이 API를 확장하여 필수 매개변수, 요청 본문 유효성 검사, 추가 REST 작업 및 필드 매핑을 사용자 지정할 수 있습니다. 자세한 내용은 Product Order Open API 개발자 안내서를 참조하십시오.
Product Order Open API는 ServiceNow® TM Forum TMF622 Product Ordering Management API REST Specification의 구현이며 TM Forum에서 적합성 인증을 받았습니다.
제품 주문 오픈 API - GET /sn_ind_tmt_orm/order/productOrder
모든 제품 주문을 검색합니다.
- 고객 주문 [sn_ind_tmt_orm_order]
- 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]
- 주문 특성 [sn_ind_tmt_orm_order_characteristic_value]
- 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact]
- 주문 라인 관련 항목 [sn_ind_tmt_orm_order_line_related_items]
URL 형식
기본 URL: / api/sn_ind_tmt_orm/order/productOrder
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 유효하지 않은 필드는 무시됩니다. 이 매개변수를 사용하지 않으면 모든 필드가 리턴됩니다. 데이터 유형: 문자열 |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 사용하여 offset 기록 검색을 페이지 매김합니다. 기본값: 20 최대값: 100 데이터 유형: 숫자 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자 |
| 상태 | 상태를 기준으로 주문을 필터링합니다. 이 매개변수의 값과 일치하는 상태의 주문만 응답에 반환됩니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 컨텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠 범위를 지정합니다. 예를 들어 offset= |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지를 매긴 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 반환된 전체 자원입니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| committedDueDate |
주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다.
이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| expectedCompletionDate (예상완료일) | 주문이 완료될 날짜입니다. 데이터 유형: 문자열 |
| href | 제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 제품 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 |
| note.author | 연결된 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열 |
| note.date | 메모가 생성된 날짜입니다. 데이터 유형: 문자열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| orderCurrency | 주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열 |
| PONN | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate |
주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다.
데이터 유형: 문자열 |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.ponr | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 제품 특성 value 과 다른 제품 previousValue 만 반환됩니다. 데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productRelationship | 주문 라인 항목의 제품 관계 상세 정보 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.productRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productRelationship.relationshipType | 주문 라인 항목과 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalId | 제품 사양의 Initial_version입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.internalId | 제품 오퍼링의 Initial_version입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.quantity | 구매한 제품 항목 수입니다. 데이터 유형: 숫자 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.state | 연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열 |
| productOrderItem.version | 주문 버전입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 데이터 유형: 문자열 |
| 버전 | 주문 버전입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 모든 제품 주문을 검색합니다.
curl --location --request GET 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder' \
--user 'username':'password'
응답 본문입니다.
[
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"orderCurrency": "USD",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI110",
"relationshipType": "Requires"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
]
제품 주문 Open API - GET /sn_ind_tmt_orm/order/productOrder/{id}
지정된 제품 주문을 조회합니다.
- 고객 주문 [sn_ind_tmt_orm_order]
- 주문 특성 [sn_ind_tmt_orm_order_characteristic_value]
- 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]
- 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact]
- 주문 라인 관련 항목 [sn_ind_tmt_orm_order_line_related_items]
URL 형식
기본 URL: / api/sn_ind_tmt_orm/order/productOrder/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 검색할 고객 주문의 Sys_id 또는 external_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 반환된 전체 자원입니다(페이지 매김 없음).
선택한 주문에 처리 문제가 있는 경우 응답이 오류 메시지와 함께 성공적으로 반환됩니다.
|
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| committedDueDate |
주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다.
이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| expectedCompletionDate (예상완료일) | 주문이 완료될 날짜입니다. 데이터 유형: 문자열 |
| href | 제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 제품 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 |
| note.author | 연결된 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열 |
| note.date | 메모가 생성된 날짜입니다. 데이터 유형: 문자열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| orderCurrency | 주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열 |
| PONN | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate |
주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다.
데이터 유형: 문자열 |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.ponr | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 제품 특성 value 과 다른 제품 previousValue 만 반환됩니다. 데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productRelationship | 주문 라인 항목의 제품 관계 상세 정보 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.productRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productRelationship.relationshipType | 주문 라인 항목과 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalId | 제품 사양의 Initial_version입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.internalId | 제품 오퍼링의 Initial_version입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.quantity | 구매한 제품 항목 수입니다. 데이터 유형: 숫자 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.state | 연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열 |
| productOrderItem.version | 주문 버전입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 데이터 유형: 문자열 |
| 버전 | 주문 버전입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 지정된 제품 주문을 검색합니다.
curl -X GET "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"
응답 본문입니다.
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"orderCurrency": "USD",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI110",
"relationshipType": "Requires"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
제품 주문 오픈 API - GET /sn_ind_tmt_orm/productorder
모든 제품 주문을 검색합니다.
- 고객 주문 [sn_ind_tmt_orm_order]
- 주문 특성 [sn_ind_tmt_orm_order_characteristic_value]
- 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]
- 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact]
URL 형식
기본 URL: / api/sn_ind_tmt_orm/productorder
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 필드 | 응답에 반환할 필드 목록입니다. 유효하지 않은 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다. |
| 제한 | 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 사용하여 offset 기록 검색을 페이지 매김합니다. 기본값: 20 최대값: 100 데이터 유형: 숫자 |
| 오프셋 | 기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자 |
| 상태 | 상태를 기준으로 주문을 필터링합니다. 이 매개변수의 값과 일치하는 상태의 주문만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 모든 상태가 반환됨. |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 컨텐츠 범위 | 페이지 매김된 호출에서 반환되는 콘텐츠 범위를 지정합니다. 예를 들어 offset= |
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
| 링크 | 쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다.
|
| X-Total-Count | 페이지를 매긴 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 기록 수를 지정합니다. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 요청이 성공적으로 처리되었습니다. 응답으로 반환된 전체 자원입니다(페이지 매김 없음). |
| 206 | 응답으로 반환된 부분 자원입니다(페이지 매김 포함). |
| 400 | 잘못된 요청. 가능한 이유:
|
| 404 | 기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| expectedCompletionDate (예상완료일) | 주문이 완료될 날짜입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 |
| note.author | 연결된 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열 |
| note.date | 메모가 생성된 날짜입니다. 데이터 유형: 문자열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| PONN | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.ponr | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 제품 특성 value 과 다른 제품 previousValue 만 반환됩니다. 데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.quantity | 구매한 제품 항목 수입니다. 데이터 유형: 숫자 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.state | 연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열 |
| productOrderItem.version | 주문 버전입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 데이터 유형: 문자열 |
| 버전 | 주문 버전입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 모든 제품 주문을 검색합니다.
curl --location --request GET 'https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder' \
--user 'username':'password'
응답 본문입니다.
[
{
"id": "8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
]
제품 주문 Open API - GET /sn_ind_tmt_orm/productorder/{id}
지정된 제품 주문을 조회합니다.
- 고객 주문 [sn_ind_tmt_orm_order]
- 주문 특성 [sn_ind_tmt_orm_order_characteristic_value]
- 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]
- 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact]
URL 형식
기본 URL: / api/sn_ind_tmt_orm/productorder/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 검색할 고객 주문의 Sys_id 또는 external_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 없음 |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음과 같은 이유로 발생할 수 있습니다.
|
| 404 | 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다. |
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| expectedCompletionDate (예상완료일) | 주문이 완료될 날짜입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 |
| note.author | 연결된 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열 |
| note.date | 메모가 생성된 날짜입니다. 데이터 유형: 문자열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| PONN | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.ponr | 주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다.
데이터 유형: 부울 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 제품 특성 value 과 다른 제품 previousValue 만 반환됩니다. 데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.quantity | 구매한 제품 항목 수입니다. 데이터 유형: 숫자 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.state | 연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열 |
| productOrderItem.version | 주문 버전입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 데이터 유형: 문자열 |
| 버전 | 주문 버전입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 기존 고객 주문을 요청합니다.
curl -X GET "https://servicenow-instance/api/sn_ind_tmt_orm/productorder/8d75939453126010a795ddeeff7b126a" \
-u "username":"password"
응답 본문입니다.
{
"id": "8d75939453126010a795ddeeff7b126a",
"ponr": "false",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrder"
}
제품 주문 Open API - 패치 /sn_ind_tmt_orm/order/productOrder/{id}
지정된 고객 주문을 업데이트합니다.
URL 형식
기본 URL: / api/sn_ind_tmt_orm/order/productOrder/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 업데이트할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| channel.id | 매개 변수를 사용하는 경우 channel 필수입니다. 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/채널 기본값: 빈 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다. 가능한 채널 이름은 sn_ind_tmt_orm_order 테이블의 채널 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 주문 라인 항목에 대한 작업이 일시 중단 또는 재개인 경우 이 매개변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date |
| 외부 ID | 고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/설명 기본값: 빈 문자열 |
| orderCurrency | 주문 및 주문 라인 항목의 통화 코드입니다. 기존 주문의 통화 코드 업데이트는 지원되지 않습니다. 주문에 이미 연결된 통화 코드 이외의 값을 제공하면 업데이트가 거부됩니다. 데이터 유형: 문자열 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.action | 매개 변수를 사용하는 경우 productOrderItem 필수입니다. 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 가능한 값:
데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/작업 기본값: add |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate | 주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다. 항목에 대한 작업이 일시 중단 또는 다시 시작이면 이 매개 변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/committed_due_date |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑할 외부 ID입니다. 데이터 유형: 문자열 테이블/필드 업데이트: sn_ind_tmt_orm_order_line_item/external_inventory_id 및 sn_prd_invt_product_inventory/sn_prd_invt_external_id |
| productOrderItem.id | 매개 변수를 사용하는 경우 productOrderItem 필수입니다. 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/external_id 최대 길이: 40 기본값: 빈 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다. 데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다. 데이터 유형: 문자열 |
| productOrderItem.product | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.id | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.id | 매개 변수를 사용하는 경우 productOrderItem.product.place 필수입니다. 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/위치 기본값: 빈 문자열 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_characteristic_value/특성 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | 매개 변수를 사용하는 경우 productOrderItem.product.productSpecification 필수입니다. 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/이메일 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/first_name 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/sys_id 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/lastName 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/business_phone 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | 매개 변수를 사용하는 경우 productOrderItem.productOffering 필수입니다. 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOrderItem.quantity | 주문에 연결된 항목의 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: null |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | 매개 변수를 사용하는 경우 productOrderItem.productOrderItemRelationship 필수입니다. 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/parent_line_item 기본값: 빈 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.quantity | 주문한 항목 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: 빈 문자열 |
| productOrderItem.revisionOperation | 라인 항목에 대해 수행할 업데이트 유형입니다. 이 값이 비어 있으면 기존 라인 항목이 업데이트되고, 아직 없는 경우 새 라인 항목이 추가됩니다. 이 값이 취소되면 라인 항목이 취소됩니다. 가능한 값:
데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | |
| relatedParty.id | |
| relatedParty.name | |
| relatedParty.@referredType | |
| relatedParty.@type | |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다.
|
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| committedDueDate |
주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다.
이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| 외부 ID | 구매 주문 번호와 같은 고객 주문의 외부 식별자입니다. 데이터 유형: 문자열 |
| href | 제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 이 요청에 대해 업데이트된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| orderCurrency | 주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate |
주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다.
데이터 유형: 문자열 |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.product.id | 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalId | 제품 사양의 Initial_version입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다.
데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.internalId | 제품 오퍼링의 Initial_version입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
데이터 유형: 문자열 |
| productOrderItem.quantity | 주문에 연결된 항목의 수입니다.
데이터 유형: 숫자 |
| productOrderItem.state | 제품 주문 항목의 현재 상태입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다.
데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다.
데이터 유형: 문자열 |
| relatedParty.type | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
이 예에서는 제품 주문에 대한 채널을 업데이트합니다.
curl -X PATCH "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
]
}
응답 본문입니다.
{
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"expectedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedCompletionDate": "2021-05-02T08:13:59.000Z",
"requestedStartDate": "2020-05-03T08:13:59.000Z",
"externalId": "PO-456",
"orderCurrency": "USD",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"author": "System Administrator",
"date": "2021-02-25T14:22:07.000Z",
"text": "This is a TMF product order illustration no 2"
},
{
"author": "System Administrator",
"date": "2021-02-25T14:22:06.000Z",
"text": "This is a TMF product order illustration"
}
],
"productOrderItem": [
{
"id": "POI130",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "Choice",
"value": "Base",
"previousValue": ""
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "v1",
"internalVersion": "1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "4175939453126010a795ddeeff7b127d",
"name": "John Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
},
{
"id": "c175939453126010a795ddeeff7b127c",
"name": "Joe Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI100",
"ponr": "false",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "v1",
"internalVersion": "1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI130",
"relationshipType": "HasChild"
},
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI110",
"relationshipType": "HasChild"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason": "adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "Choice",
"value": "Physical",
"previousValue": ""
},
{
"name": "WAN Optimization",
"valueType": "Choice",
"value": "Advance",
"previousValue": ""
},
{
"name": "Routing",
"valueType": "Choice",
"value": "Premium",
"previousValue": ""
},
{
"name": "CPE Model",
"valueType": "Choice",
"value": "ASR",
"previousValue": ""
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "v1",
"internalVersion": "1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
},
{
"id": "POI110",
"ponr": "false",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "INR",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 5
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "Choice",
"value": "Base (10 site)",
"previousValue": ""
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "v1",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"state": "in_progress",
"version": "1",
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"state": "in_progress",
"@type": "ProductOrder"
}
제품 주문 Open API - 패치 /sn_ind_tmt_orm/productorder/{id}
지정된 고객 주문을 업데이트합니다.
URL 형식
기본 URL: / api/sn_ind_tmt_orm/productorder/{id}
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| ID | 업데이트할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| channel.id | 매개 변수를 사용하는 경우 channel 필수입니다. 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/채널 기본값: 빈 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다. 가능한 채널 이름은 sn_ind_tmt_orm_order 테이블의 채널 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| committedDueDate | 주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 주문 라인 항목에 대한 작업이 일시 중단 또는 재개인 경우 이 매개변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date |
| 외부 ID | 고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/설명 기본값: 빈 문자열 |
| orderCurrency | 주문 및 주문 라인 항목의 통화 코드입니다. 기존 주문의 통화 코드 업데이트는 지원되지 않습니다. 주문에 이미 연결된 통화 코드 이외의 값을 제공하면 업데이트가 거부됩니다. 데이터 유형: 문자열 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.action | 매개 변수를 사용하는 경우 productOrderItem 필수입니다. 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 가능한 값:
데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/작업 기본값: add |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate | 주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다. 항목에 대한 작업이 일시 중단 또는 다시 시작이면 이 매개 변수를 업데이트할 수 없습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/committed_due_date |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑할 외부 ID입니다. 데이터 유형: 문자열 테이블/필드 업데이트: sn_ind_tmt_orm_order_line_item/external_inventory_id 및 sn_prd_invt_product_inventory/sn_prd_invt_external_id |
| productOrderItem.id | 매개 변수를 사용하는 경우 productOrderItem 필수입니다. 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/external_id 최대 길이: 40 기본값: 빈 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다. 데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다. 데이터 유형: 문자열 |
| productOrderItem.product | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.id | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.id | 매개 변수를 사용하는 경우 productOrderItem.product.place 필수입니다. 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/위치 기본값: 빈 문자열 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_characteristic_value/특성 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | 매개 변수를 사용하는 경우 productOrderItem.product.productSpecification 필수입니다. 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/이메일 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/first_name 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/sys_id 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/lastName 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/business_phone 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | 매개 변수를 사용하는 경우 productOrderItem.productOffering 필수입니다. 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOrderItem.quantity | 주문에 연결된 항목의 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: null |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | 매개 변수를 사용하는 경우 productOrderItem.productOrderItemRelationship 필수입니다. 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/parent_line_item 기본값: 빈 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.quantity | 주문한 항목 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: 빈 문자열 |
| productOrderItem.revisionOperation | 라인 항목에 대해 수행할 업데이트 유형입니다. 이 값이 비어 있으면 기존 라인 항목이 업데이트되고, 아직 없는 경우 새 라인 항목이 추가됩니다. 이 값이 취소되면 라인 항목이 취소됩니다. 가능한 값:
데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | |
| relatedParty.id | |
| relatedParty.name | |
| relatedParty.@referredType | |
| relatedParty.@type | |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다.
|
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| ID | 이 요청에 대해 업데이트된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 외부 ID | 구매 주문 번호와 같은 고객 주문의 외부 식별자입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.product.id | 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다.
데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.id | 주문 라인 항목과 연결된 라인 항목 접촉 Sys_id입니다. 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
데이터 유형: 문자열 |
| productOrderItem.quantity | 주문에 연결된 항목의 수입니다.
데이터 유형: 숫자 |
| productOrderItem.state | 제품 주문 항목의 현재 상태입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다.
데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다.
데이터 유형: 문자열 |
| relatedParty.type | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 고객 주문에 대한 채널을 업데이트합니다.
curl -X PATCH "https://instance.servicenow.com/api/sn_ind_tmt_orm/productorder/6be0a925c3a220103e2e73ce3640ddfe" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
]
}
응답 본문입니다.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"channel": [
{
"id": "1",
"name": "Agent Assist"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "6be0a925c3a220103e2e73ce3640ddfe",
"state": "in_progress"
}
제품 주문 오픈 API - POST /sn_ind_tmt_orm/cancelproductorder
지정된 고객 주문을 취소합니다.
URL 형식
기본 URL: / api/sn_ind_tmt_orm/cancelproductorder
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| cancellationReason | 취소 사유입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| 제품 주문 | 제품 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 |
| productOrder.id | 필수 취소할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrder.href | 취소할 고객 주문의 URL입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrder.@referredType | 이 매개 변수의 값은 ProductOrder여야 합니다.데이터 유형: 문자열 기본값: 빈 문자열 |
| requestedCancellationDate | 주문을 취소할 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| @type | 이 매개 변수의 값은 CancelProductOrder여야 합니다.데이터 유형: 문자열 기본값: 빈 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| cancellationReason | 취소 사유입니다. 데이터 유형: 문자열 |
| href | 취소된 주문의 URL입니다. 데이터 유형: 문자열 |
| ID | 취소된 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 제품 주문 | 제품 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 |
| productOrder.id | 취소된 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| productOrder.href | 취소된 주문의 URL입니다. 데이터 유형: 문자열 |
| productOrder.@referredType | 이 매개 변수의 값은 ProductOrder입니다.데이터 유형: 문자열 |
| requestedCancellationDate | 주문을 취소할 날짜입니다. 데이터 유형: 문자열 |
| 상태 | 취소의 상태입니다. 취소 요청이 성공적으로 처리되면(201 상태 코드) 이 매개변수의 값은 완료됩니다.데이터 유형: 문자열 |
| @type | 이 매개 변수의 값은 CancelProductOrder입니다.데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 고객 주문을 취소합니다.
curl -X POST "https://instance.servicenow.com/api/sn_ind_tmt_orm/cancelproductorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2019-04-30T12:56:21.931Z",
"productOrder": {
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"@referredType": "ProductOrder"
},
"@type": "CancelProductorder"
}
{
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"cancellationReason": "Duplicate order",
"requestedCancellationDate": "2019-04-30T12:56:21.931Z",
"@type": "CancelProductorder",
"productOrder": {
"id": "163ee2805358811032a4ddeeff7b122d",
"href": "https://instance.servicenow.com/productOrderingManagement/v4/productOrder/64a9607feb45301032a442871352285b",
"@referredType": "ProductOrder"
},
"state": "done"
}
제품 주문 오픈 API - POST /sn_ind_tmt_orm/order/productOrder
지정된 고객 주문 및 고객 주문 라인 항목을 생성합니다.
- 고객 주문 [sn_ind_tmt_orm_order]
- 주문 특성 [sn_ind_tmt_orm_order_characteristic_value]
- 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]
- 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact]
- 주문 라인 관련 항목 [sn_ind_tmt_orm_order_line_related_items]
URL 형식
기본 URL: / api/sn_ind_tmt_orm/order/productOrder
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 모드 | 비동기 주문 처리를 활성화합니다. 즉, 생성할 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 주문이 추가됩니다. 포함되지 않은 경우 주문은 동기식으로 처리됩니다. 가능한 값: async 데이터 유형: 문자열 |
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| channel.id | 필수 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/채널 기본값: 빈 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다. 가능한 채널 이름은 sn_ind_tmt_orm_order 테이블의 채널 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| committedDueDate |
주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다.
이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date |
| 외부 ID | 고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모가 포함된 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| note.text | 필수 주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/설명 기본값: 빈 문자열 |
| orderCurrency | 필수 주문 및 주문 라인 항목의 통화 코드입니다. 통화는 주문 및 주문 라인 항목의 모든 요소에 대해 동일해야 합니다. 그렇지 않으면 오류가 반환되고 주문이 생성되지 않습니다. 주문이 생성되면 통화 코드를 변경할 수 없습니다. 데이터 유형: 문자열 |
| 제품 주문 항목 | 필수 제품 주문과 연결된 항목 및 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.action | 필수 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 가능한 값:
데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/작업 |
| productOrderItem.actionReason | 옵션입니다. 주문 라인 항목의 이유에 대한 설명입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate |
주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다.
데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/committed_due_date |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑할 외부 ID입니다. 데이터 유형: 문자열 테이블/필드 업데이트: sn_ind_tmt_orm_order_line_item/external_inventory_id 및 sn_prd_invt_product_inventory/sn_prd_invt_external_id |
| productOrderItem.id | 필수 라인 항목의 고유 식별자입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/external_id 최대 길이: 40 기본값: 빈 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.priceType | 항목의 가격이 반복되는지 아니면 반복되지 않는지를 지정합니다. 데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간을 지정합니다. 데이터 유형: 문자열 |
| productOrderItem.product | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.id | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.id | 필수 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/위치 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | 제품과 연관된 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_characteristic_value/특성 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productSpecification | 필수 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | 필수 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | OrderLineItemContact에 연결된 파티 역할을 설명하는 개체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/이메일 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/first_name 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/lastName 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/business_phone 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.@referredType | 필수 고객의 유형입니다. 가능한 값 – OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering | 필수 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | 필수 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOrderItem.quantity | 주문에 연결된 항목의 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: null |
| productOrderItem.productOrderItemRelationship | 필수 주문 항목 간의 상위/하위 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | 필수 값과 productOrderItem.id 동일합니다. 상위/하위 관계에 사용됨 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/parent_line_item 기본값: 빈 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 필수 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값:
데이터 유형: 문자열 |
| productOrderItem.quantity | 주문한 항목 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: 빈 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정 또는 고객 접촉 창구의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 필수 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다.
|
| 202 | 허용. 비동기 모드에서 주문을 성공적으로 요청했습니다. 즉, 매개변수가 modeasync 로 설정된 상태에서 요청이 이루어졌고 기록은 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에서 처리되도록 예약되어 있습니다. |
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| committedDueDate |
주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다.
이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 |
| 외부 ID | 구매 주문 번호와 같은 고객 주문의 외부 식별자입니다. 데이터 유형: 문자열 |
| href | 제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 |
| ID | 이 요청에 대해 생성된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| orderCurrency | 주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열 |
| orderId | 생성할 주문의 Sys_id입니다. 요청이 성공하면 주문이 일정에 따라 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 추가되어 처리됩니다. 주:
이 값은 순서가 쿼리 매개 변수를 사용하여 비동기적으로 만들어지는 mode 경우의 유일한 결과입니다.
데이터 유형: 문자열 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOrderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate |
주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다.
데이터 유형: 문자열 |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑된 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열 |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.product.id | 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다.이 매개 변수는 변경 또는 연결 끊기인 경우에만 productOrderItem.action 반환됩니다. sys_id과 external_id이 모두 있으면 external_id 반환됩니다. 데이터 유형: 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productRelationship | 주문 라인 항목의 제품 관계 상세 정보 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.productRelationship.id | 제품 인벤토리의 Sys_id 또는 sn_prd_invt_external_id입니다. 제품 인벤토리 [sn_prd_invt_product_inventory] 테이블의 sys_id 또는 sn_prd_invt_external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productRelationship.relationshipType | 주문 라인 항목과 제품 인벤토리 간의 관계 유형입니다. 가능한 값: 필요 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. sys_id과 external_id이 모두 있으면 external_id 반환됩니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalId | 제품 사양의 Initial_version입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다. sys_id과 external_id이 모두 있으면 external_id 반환됩니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalId | 제품 오퍼링의 Initial_version입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
가능한 값:
HasChild 및 HasParent 는 부모/자식 관계에 사용됩니다. Requires 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함).데이터 유형: 문자열 |
| productOrderItem.quantity | 주문에 연결된 항목의 수입니다.
데이터 유형: 숫자 |
| productOrderItem.state | 제품 주문 항목의 현재 상태입니다. 이 값은 항상 새 값입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다.
데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다.
데이터 유형: 문자열 |
| relatedParty.type | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 이 엔드포인트의 경우 이 값은 항상 새 값입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
비동기적으로 처리
이 예제에서는 query 매개 변수를 사용하여 mode 비동기적으로 주문을 만드는 방법을 보여 줍니다. 생성할 일정에 따라 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 주문이 추가됩니다.
curl -X POST 'https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder?mode=async' \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d '{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"orderDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-4ddd56",
"orderCurrency": "USD",
"note": [
{
"id": "1",
"author": "Jean Pontus",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration"
},
{
"id": "2",
"author": "Jean Pontus1",
"date": "2019-04-30T08:13:59.509Z",
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "100",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"product": {
"isBundle": false,
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "110",
"relationshipType": "HasChild"
},
{
"id": "120",
"relationshipType": "HasChild"
},
{
"id": "130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "110",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"description": "Access Fee",
"name": "Access Fee",
"priceType": "nonRecurring",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 100
},
"taxIncludedAmount": {
"unit": "USD",
"value": 220
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "Tenancy",
"valueType": "string",
"value": "Premium (>50 sites)"
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "120",
"action": "add",
"actionReason":"adding service package OLI",
"quantity": 1,
"itemPrice": [
{
"description": "Tariff plan monthly fee",
"name": "MonthlyFee",
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 300
},
"taxIncludedAmount": {
"unit": "USD",
"value": 349
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "CPE Model",
"valueType": "string",
"value": "ASR"
},
{
"name": "WAN Optimization",
"valueType": "string",
"value": "Advance"
},
{
"name": "CPE Type",
"valueType": "string",
"value": "Physical"
},
{
"name": "Routing",
"valueType": "string",
"value": "Premium"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"description": "Tariff plan monthly security",
"name": "MonthlySecurity",
"priceType": "nonRecurring",
"recurringChargePeriod": "month",
"price": {
"taxRate": 0,
"dutyFreeAmount": {
"unit": "USD",
"value": 30
},
"taxIncludedAmount": {
"unit": "USD",
"value": 30
}
}
}
],
"product": {
"isBundle": false,
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"valueType": "string",
"value": "Premium"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"place": {
"@type": "Place",
"id": "5671dd2ec3a53010188473ce3640dd81"
},
"relatedParty": [
{
"firstName": "John",
"lastName": "Smith",
"email": "abc2@example.com",
"phone": "32456768",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"productRelationship": [
{
"id": "be6d13f45b5620102dff5e92dc81c781",
"relationshipType": "Requires"
}
]
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}'
응답 본문입니다.
{
"orderId": "304e877ac3ab5110856d73ce3640dde5"
}
동기식으로 처리(기본값)
다음 예제에서는 제품 주문을 생성하는 방법을 보여 줍니다.
curl -X POST "https://instance.service-now.com/api/sn_ind_tmt_orm/order/productOrder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"currencyCode": "USD",
"channel": [
{
"id": "2",
"name": "Online channel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI130",
"relationshipType": "Requires"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}
응답 본문입니다.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"currencyCode": "USD",
"channel": [
{
"id": "2",
"name": "Online chanel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"internalVersion": "1",
"version": "v1",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"internalVersion": "1",
"version": "v1",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"@type": "ProductSpecificationRef"
},
"productRelationship": [
{
"id": "326d13f45b5620102dff5e92dc81c785",
"relationshipType": "Requires"
}
],
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
},
{
"id": "POI130",
"relationshipType": "Requires"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"actionReason":"adding service package OLI",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"internalVersion": "1",
"version": "v1",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"internalVersion": "1",
"version": "v1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "8d75939453126010a795ddeeff7b126a",
"href": "/api/sn_ind_tmt_orm/order/productOrder/8d75939453126010a795ddeeff7b126a",
"state": "new"
}
제품 주문 오픈 API - POST /sn_ind_tmt_orm/productorder
지정된 고객 주문 및 고객 주문 라인 항목을 생성합니다.
- 고객 주문 [sn_ind_tmt_orm_order]
- 주문 특성 [sn_ind_tmt_orm_order_characteristic_value]
- 주문 라인 항목 [sn_ind_tmt_orm_order_line_item]
- 주문 라인 항목 연락처 [sn_ind_tmt_orm_order_line_item_contact]
URL 형식
기본 URL: / api/sn_ind_tmt_orm/productorder
지원되는 요청 매개변수
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 없음 |
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| channel.id | 필수 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/채널 기본값: 빈 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다. 가능한 채널 이름은 sn_ind_tmt_orm_order 테이블의 채널 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| committedDueDate |
주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다.
이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/committed_due_date |
| 외부 ID | 고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모가 포함된 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order |
| note.text | 필수 주문하는 동안 고객이 작성한 추가 메모/의견입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/설명 기본값: 빈 문자열 |
| orderCurrency | 필수 주문 및 주문 라인 항목의 통화 코드입니다. 통화는 주문 및 주문 라인 항목의 모든 요소에 대해 동일해야 합니다. 그렇지 않으면 오류가 반환되고 주문이 생성되지 않습니다. 주문이 생성되면 통화 코드를 변경할 수 없습니다. 데이터 유형: 문자열 |
| 제품 주문 항목 | 필수 제품 주문과 연결된 항목 및 관련 작업을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.action | 필수 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다. 가능한 값:
데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/작업 |
| productOrderItem.actionReason | 옵션입니다. 주문 라인 항목의 이유에 대한 설명입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.committedDueDate |
주문 라인 항목에서 작업을 수행해야 하는 날짜 및 시간입니다.
데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/committed_due_date |
| productOrderItem.externalProductInventory | 주문에 대해 생성된 제품 인벤토리에 매핑할 외부 ID를 포함하는 객체의 배열입니다. 데이터 유형: 배열 |
| productOrderItem.externalProductInventory.externalProductInventoryId | 제품 인벤토리에 매핑할 외부 ID입니다. 데이터 유형: 문자열 테이블/필드 업데이트: sn_ind_tmt_orm_order_line_item/external_inventory_id 및 sn_prd_invt_product_inventory/sn_prd_invt_external_id |
| productOrderItem.id | 필수 라인 항목의 고유 식별자입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/external_id 최대 길이: 40 기본값: 빈 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열 |
| productOrderItem.itemPrice.price.taxIncludedAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.itemPrice.price.taxIncludedAmount.unit | 가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.price.taxIncludedAmount.value | 세금을 포함한 제품 가격입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/mrc 또는 nrc |
| productOrderItem.itemPrice.priceType | 항목의 가격이 반복되는지 아니면 반복되지 않는지를 지정합니다. 데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간을 지정합니다. 데이터 유형: 문자열 |
| productOrderItem.product | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.id | 변경/연결 해제인 경우 productOrderItem.action 필요합니다. 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.place.id | 필수 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/위치 |
| productOrderItem.product.place.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 Place입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value |
| productOrderItem.product.productCharacteristic.name | 제품과 연관된 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order_characteristic_value/특성 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 . 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열 |
| productOrderItem.product.productSpecification | 필수 제품과 연관된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.product.productSpecification.id | 필수 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.internalVersion | 제품 사양의 버전입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.version | 제품 사양의 External_version입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | OrderLineItemContact에 연결된 파티 역할을 설명하는 개체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/이메일 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/first_name 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/lastName 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item_contact/business_phone 기본값: 빈 문자열 |
| productOrderItem.product.relatedParty.@referredType | 필수 고객의 유형입니다. 가능한 값 – OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering | 필수 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 업데이트된 테이블: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOffering.id | 필수 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.internalVersion | 제품 오퍼링 버전입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.version | 제품 오퍼링의 External_version입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다. 데이터 유형: 문자열 |
| productOrderItem.productOrderItem.quantity | 주문에 연결된 항목의 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: null |
| productOrderItem.productOrderItemRelationship | 필수 주문 항목 간의 상위/하위 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item |
| productOrderItem.productOrderItemRelationship.id | 필수 값과 productOrderItem.id 동일합니다. 상위/하위 관계에 사용됨 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/parent_line_item 기본값: 빈 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 필수 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값:
데이터 유형: 문자열 |
| productOrderItem.quantity | 주문한 항목 수입니다. 데이터 유형: 숫자 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/수량 기본값: 빈 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정 또는 고객 접촉 창구의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다. 데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열 |
| relatedParty.@referredType | 필수 고객의 유형입니다. 가능한 값:
데이터 유형: 문자열 |
| relatedParty.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_end_date 기본값: 빈 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/expected_start_date 기본값: 빈 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.
| 헤더 | 설명 |
|---|---|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 컨텐츠-형식 | 요청 본문의 데이터 형식입니다. application/json만 지원합니다. |
| 헤더 | 설명 |
|---|---|
| 콘텐츠-형식 | 응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json. |
상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.
| 상태 코드 | 설명 |
|---|---|
| 201 | 성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다.
|
| 400 | 잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다.
|
응답 본문 매개변수(JSON)
| 이름 | 설명 |
|---|---|
| 채널 | 제품 판매에 사용할 채널을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| channel.id | 관련 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다.
데이터 유형: 문자열 |
| channel.name | 관련 제품을 판매하는 데 사용할 채널의 이름입니다.
데이터 유형: 문자열 |
| ID | 이 요청에 대해 생성된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| 외부 ID | 구매 주문 번호와 같은 고객 주문의 외부 식별자입니다. 데이터 유형: 문자열 |
| 참고 | 주문 시 고객이 작성한 추가 메모를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| note.text | 주문하는 동안 고객이 작성한 추가 메모/의견입니다.
데이터 유형: 문자열 |
| 제품 주문 항목 | 제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 |
| productOrderItem.action | 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의됩니다.
데이터 유형: 문자열 |
| productOderItem.actionReason | 주문 라인 항목을 추가하는 이유입니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_line_item/action_reason |
| productOrderItem.id | 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice | 제품과 연결된 가격을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.itemPrice.price | 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount | 세금을 포함한 관련 제품의 가격에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.itemPrice.price.taxIncludeAmount.unit | 가격이 표시되는 통화 코드입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.price.taxIncludeAmount.value | 세금을 포함한 제품 가격입니다.
데이터 유형: 숫자 |
| productOrderItem.itemPrice.priceType | 항목 가격의 유형(반복 또는 비반복)입니다.
데이터 유형: 문자열 |
| productOrderItem.itemPrice.recurringChargePeriod | 가격이 반복되는 경우 월과 같은 반복 기간입니다.
데이터 유형: 문자열 |
| productOrderItem.product | 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.product.id | 판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다.이 매개 변수는 변경 또는 연결 끊기인 경우에만 productOrderItem.action 반환됩니다. sys_id과 external_id이 모두 있으면 external_id 반환됩니다. 데이터 유형: 문자열 |
| productOrderItem.product.place | 제품을 설치할 위치의 맵입니다.
데이터 유형: 객체 |
| productOrderItem.product.place.id | 위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic | 연결된 제품의 특성을 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.product.productCharacteristic.name | 제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.previousValue | 업데이트가 변경 주문에 대한 업데이트인 경우 이전 특성 옵션 값입니다. 매개변수가 add가 아닌 경우 productOrderItem.action 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productCharacteristic.value | 제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 .
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification | 제품과 연관된 제품 사양에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.product.productSpecification.id | 제품 사양의 Initial_version 또는 external_id입니다. initial_version은 사양의 첫 번째 버전의 sys_id입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블의 sys_id 또는 external_id 필드에 있습니다. sys_id과 external_id이 모두 있으면 external_id 반환됩니다. 데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.name | 제품 사양의 이름입니다. 제품 사양 [sn_prd_pm_product_specification] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.product.productSpecification.@type | TMF Open API 표준의 일부입니다. 이 값은 항상 ProductSpecificationRef입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty | 라인 항목의 연락처 목록입니다. 데이터 유형: 배열 |
| productOrderItem.product.relatedParty.email | 접촉 창구의 이메일 주소입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.firstName | 접촉 창구의 이름입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.성 | 연락처의 성.
데이터 유형: 문자열 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.phone | 접촉 창구의 직장 전화 번호입니다.
데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@referredType | 고객의 유형입니다.
가능한 값: OrderLineItemContact 데이터 유형: 문자열 |
| productOrderItem.product.relatedParty.@type | TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 RelatedParty입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.product.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 Product입니다. 이 정보는 저장되지 않습니다.
데이터 유형: 문자열 |
| productOrderItem.productOffering | 제품과 연결된 제품 오퍼링에 대한 설명입니다.
데이터 유형: 객체 |
| productOrderItem.productOffering.id | 제품 오퍼링의 Initial_version 또는 external_id입니다. initial_version은 오퍼링의 첫 번째 버전에 대한 sys_id입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블의 sys_id 또는 external_id 필드에 있습니다. sys_id과 external_id이 모두 있으면 external_id 반환됩니다. 데이터 유형: 문자열 |
| productOrderItem.productOffering.name | 제품 오퍼링의 이름입니다. 제품 오퍼링 [sn_prd_pm_product_offering] 테이블에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship | 주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다.
데이터 유형: 배열 |
| productOrderItem.productOrderItemRelationship.id | 관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다.
데이터 유형: 문자열 |
| productOrderItem.productOrderItemRelationship.relationshipType | 두 라인 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다.
데이터 유형: 문자열 |
| productOrderItem.quantity | 주문에 연결된 항목의 수입니다.
데이터 유형: 숫자 |
| productOrderItem.state | 제품 주문 항목의 현재 상태입니다. 이 값은 항상 새 값입니다. 데이터 유형: 문자열 |
| productOrderItem.@type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrderItem입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
| 관련 당사자 | 주문에 대한 연락처 목록입니다. 각 연락처는 배열의 객체입니다. 고객 계정 또는 소비자 계정 정보를 포함하는 항목을 하나 이상 나열해야 합니다.
데이터 유형: 배열 |
| relatedParty.id | 주문과 연결된 계정, 고객 연락처 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다.
데이터 유형: 문자열 |
| relatedParty.name | 계정, 고객 또는 소비자의 이름입니다.
데이터 유형: 문자열 |
| relatedParty.type | 고객의 유형입니다.
가능한 값:
데이터 유형: 문자열 |
| requestedCompletionDate | 고객이 요청한 배송 날짜입니다.
데이터 유형: 문자열 |
| requestedStartDate (요청된 시작 날짜) | 고객이 요청한 주문 시작 날짜입니다.
데이터 유형: 문자열 |
| 상태 | 주문의 현재 상태입니다. 이 엔드포인트의 경우 이 값은 항상 새 값입니다. 데이터 유형: 문자열 |
| @type | TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 ProductOrder입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열 |
cURL 요청
다음 코드 예제에서는 고객 주문을 만듭니다.
curl -X POST "https://servicenow-instance/api/sn_ind_tmt_orm/productorder" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-u "username":"password" \
-d {
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"channel": [
{
"id": "2",
"name": "Online channel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder"
}
응답 본문입니다.
{
"requestedCompletionDate": "2021-05-02T08:13:59.506Z",
"requestedStartDate": "2020-05-03T08:13:59.506Z",
"externalId": "PO-456",
"channel": [
{
"id": "2",
"name": "Online chanel"
}
],
"note": [
{
"text": "This is a TMF product order illustration"
},
{
"text": "This is a TMF product order illustration no 2"
}
],
"productOrderItem": [
{
"id": "POI100",
"quantity": 1,
"action": "change",
"product": {
"id": "fa6d13f45b5620102dff5e92dc81c77f",
"@type": "Product",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"@type": "ProductSpecificationRef"
},
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI120",
"relationshipType": "HasChild"
},
{
"id": "POI130",
"relationshipType": "HasChild"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI120",
"quantity": 1,
"action": "change",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"id": "766d13f45b5620102dff5e92dc81c78a",
"@type": "Product",
"productCharacteristic": [
{
"name": "WAN Optimization",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
},
{
"id": "POI130",
"quantity": 1,
"action": "add",
"itemPrice": [
{
"priceType": "recurring",
"recurringChargePeriod": "month",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 20
}
}
}
],
"product": {
"@type": "Product",
"productCharacteristic": [
{
"name": "Security Type",
"value": "Base",
"previousValue": "Advance"
}
],
"productSpecification": {
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"@type": "ProductSpecificationRef"
},
"relatedParty": [
{
"id": "51670151c35420105252716b7d40ddfe",
"firstName": "Joe",
"lastName": "Doe",
"email": "abc@example.com",
"phone": "1234567890",
"@type": "RelatedParty",
"@referredType": "OrderLineItemContact"
}
],
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"@type": "Place"
}
},
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"productOrderItemRelationship": [
{
"id": "POI100",
"relationshipType": "HasParent"
}
],
"@type": "ProductOrderItem",
"state": "new"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "59f16de1c3b67110ff00ed23a140dd9e",
"name": "Funco External",
"@type": "RelatedParty",
"@referredType": "Consumer"
}
],
"@type": "ProductOrder",
"id": "6be0a925c3a220103e2e73ce3640ddfe",
"state": "new"
}