제품 주문 오픈 API

릴리스 버전: Xanadu

업데이트 날짜 2024년 08월 01일

읽기325분

Product Order Open API는 제품 주문을 위한 표준화된 메커니즘을 사용할 수 있는 엔드포인트를 제공합니다.

제품 주문은 제품 카탈로그에 정의되고 게시된 제품 오퍼링을 기반으로 생성됩니다. 제품 오퍼링은 고객에게 제공되는 제품 또는 제품 세트를 식별하고, 제품의 고유한 옵션을 캡처하는 관련 제품 특성과 가격 책정, 계약 조건 및 가용성과 같은 기타 관련 속성을 포함합니다.

이 API에 접근하려면 sn_ind_tmt_orm(Order Management for Telecommunications) 플러그인이 활성화되어 있어야 합니다.

이 API는 sn_ind_tmt_orm 네임스페이스 내에서 제공됩니다.

호출하는 사용자에게 sn_ind_tmt_orm.order_integrator 역할이 있어야 합니다.

이 API를 확장하여 필수 매개변수, 요청 본문 확인, 추가 REST 작업 및 필드 매핑을 중심으로 사용자 지정할 수 있습니다. 자세한 내용은 제품 주문 Open API 개발자 가이드.

Product Order Open API는 TM Forum TMF622 Product Ordering Management API REST 사양의 구현이며 ServiceNow® TM Forum의 적합성 인증을 받았습니다.

TMF 적합성 로고

제품 주문 오픈 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

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
없음

표 2. 쿼리 매개변수
이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 이 매개 변수를 사용하지 않으면 모든 필드가 반환됩니다. 데이터 유형: 문자열
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자
상태	상태별로 주문을 필터링합니다. 이 매개변수의 값과 일치하는 상태를 가진 주문만 응답에 반환됩니다. 데이터 유형: 문자열

표 3. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
없음

표 5. 응답 헤더
헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다.
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원입니다(페이지 매김 포함).
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
예상 완료 날짜	주문이 완료될 날짜입니다. 데이터 유형: 문자열
href	제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
id	제품 주문의 Sys_id입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	관련 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
note.date	메모가 생성된 날짜입니다. 데이터 유형: 문자열
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
주문 통화	주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열
폰(ponr)	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열
productOrderItem.id	라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.itemPrice	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludedAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.ponr	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.place.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 `항상 Place`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 와 previousValue 다른 제품 특성 value 만 반환됩니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productRelationship	주문 라인 항목에 대한 제품 관계 상세 정보 목록입니다. 데이터 유형: 배열 `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty:" [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
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.lastName	연락처의 성입니다. 데이터 유형: 문자열 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.productOrderItemRelationship.relationshipType	두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하일드 부모 존재 여부 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.state	연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열
productOrderItem.version	주문 버전. 데이터 유형: 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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"
   }
]

제품 주문 오픈 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}

지원되는 요청 매개변수

표 7. 경로 매개변수
이름	설명
id	검색할 고객 주문의 Sys_id 또는 external_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열

표 8. 쿼리 매개변수
이름	설명
없음

표 9. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

표 10. 요청 헤더
헤더	설명
없음

표 11. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 12. 상태 코드
상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음). 선택한 주문에 처리 문제가 있는 경우 응답이 오류 메시지와 함께 성공적으로 반환됩니다. 스케줄러가 처리할 기록을 선택하기를 기다리는 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에 주문이 있는 경우 200 OK 응답이 발생합니다. 오류 메시지 필드에는 기록에 대한 세부 정보가 포함됩니다. 예: `{ "code": 102, "reason": "Request in queue", "message": "Request in queue", "details": [ { "message": "This Order is still in the inbound queue table waiting to be processed.", "datapath": "" } ] }` 주문 생성이 실패하고 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블의 기록이 오류 상태인 경우 200 OK 응답이 발생합니다. 오류 메시지 필드에는 인바운드 큐 테이블 기록에 대한 세부 정보가 포함됩니다. 예: `{ "code": 23, "reason": "Missing body field", "message": "Missing body field", "details": [ { "message": "Invalid payload: orderCurrency is missing", "datapath": "/" } ] }`
206	응답으로 반환된 부분 자원입니다(페이지 매김 포함).
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
예상 완료 날짜	주문이 완료될 날짜입니다. 데이터 유형: 문자열
href	제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
id	제품 주문의 Sys_id입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "author": "String", "date": "String", "text": "String" } ]`
note.author	관련 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
note.date	메모가 생성된 날짜입니다. 데이터 유형: 문자열
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
주문 통화	주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열
폰(ponr)	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열
productOrderItem.id	라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.itemPrice	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludedAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.ponr	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product:" { "place": {Object}, "productCharacteristic": [Array], "productRelationship": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.place.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 `항상 Place`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 와 previousValue 다른 제품 특성 value 만 반환됩니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productRelationship	주문 라인 항목에 대한 제품 관계 상세 정보 목록입니다. 데이터 유형: 배열 `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
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.lastName	연락처의 성입니다. 데이터 유형: 문자열 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.productOrderItemRelationship.relationshipType	두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하일드 부모 존재 여부 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.state	연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열
productOrderItem.version	주문 버전. 데이터 유형: 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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

모든 제품 주문을 검색합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 제품 주문 오픈 API - GET /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]

URL 형식

기본 URL: /api/sn_ind_tmt_orm/productorder

지원되는 요청 매개변수

표 13. 경로 매개변수
이름	설명
없음

표 14. 쿼리 매개변수
이름	설명
필드	응답에 반환할 필드 목록입니다. 잘못된 필드는 무시됩니다. 데이터 유형: 문자열 기본값: 모든 필드가 반환됩니다.
제한	반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 매개변수를 offset 사용하여 기록 검색을 페이지 매김합니다. 기본값: 20 최대: 100 데이터 유형: 숫자
오프셋	기록 검색을 시작할 시작 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다. 기본값: 0 데이터 유형: 숫자
상태	상태별로 주문을 필터링합니다. 이 매개변수의 값과 일치하는 상태를 가진 주문만 응답에 반환됩니다. 데이터 유형: 문자열 기본값: 모든 상태가 반환됩니다.

표 15. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

표 16. 요청 헤더
헤더	설명
없음

표 17. 응답 헤더
헤더	설명
콘텐츠 범위	페이지 매김된 호출에서 반환되는 콘텐츠의 범위를 지정합니다. 예를 들어 `offset=2` 및 `limit=3`인 경우 헤더의 Content-Range 값은 `항목 3-5`입니다.
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.
링크	쿼리 결과를 탐색할 수 있는 다음 링크가 포함되어 있습니다. 첫 번째 마지막 다음 이전
X-Total-Count	페이지가 매겨진 쿼리의 경우 이 헤더는 서버에서 사용할 수 있는 총 레코드 수를 지정합니다.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 18. 상태 코드
상태 코드	설명
200	요청이 성공적으로 처리되었습니다. 응답으로 전체 자원이 반환되었습니다(페이지 매김 없음).
206	응답으로 반환된 부분 자원입니다(페이지 매김 포함).
400	잘못된 요청입니다. 가능한 이유: 잘못된 경로 매개변수 잘못된 URI
404	기록 없음 테이블에서 쿼리 매개변수와 일치하는 기록을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
예상 완료 날짜	주문이 완료될 날짜입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": { "author": "String", "date": "String", "text": "String" }`
note.author	관련 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
note.date	메모가 생성된 날짜입니다. 데이터 유형: 문자열
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
폰(ponr)	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludedAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.ponr	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.place.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 `항상 Place`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 와 previousValue 다른 제품 특성 value 만 반환됩니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
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.lastName	연락처의 성입니다. 데이터 유형: 문자열 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.productOrderItemRelationship.relationshipType	두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하일드 부모 존재 여부 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.state	연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열
productOrderItem.version	주문 버전. 데이터 유형: 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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"
   }
]

제품 주문 오픈 API - GET /sn_ind_tmt_orm/productorder/{id}

지정된 제품 주문을 검색합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 제품 주문 오픈 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]

URL 형식

기본 URL: /api/sn_ind_tmt_orm/productorder/{id}

지원되는 요청 매개변수

표 19. 경로 매개변수
이름	설명
id	검색할 고객 주문의 Sys_id 또는 external_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열

표 20. 쿼리 매개변수
이름	설명
없음

표 21. 요청 본문 매개변수(JSON)
이름	설명
없음

헤더

표 22. 요청 헤더
헤더	설명
없음

표 23. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 24. 상태 코드
상태 코드	설명
201	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. 쿼리 매개변수 누락 잘못된 URI
404	찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
예상 완료 날짜	주문이 완료될 날짜입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": { "author": "String", "date": "String", "text": "String" }`
note.author	관련 메모를 작성한 사람의 사용자 이름입니다. 데이터 유형: 문자열
note.date	메모가 생성된 날짜입니다. 데이터 유형: 문자열
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
폰(ponr)	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludedAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludedAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.ponr	주문에 대한 반품 불가 지점에 도달했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. true: 주문에 대한 반품 불가 지점에 도달했습니다. false: 주문에 대한 반품 불가 지점에 도달하지 않았습니다. 데이터 유형: 부울
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product:" { "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.place.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 `항상 Place`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 와 previousValue 다른 제품 특성 value 만 반환됩니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification:" { "id": "String", "name": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty:" { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" }`
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.lastName	연락처의 성입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.productOrderItemRelationship.relationshipType	두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하일드 부모 존재 여부 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.state	연결된 제품 항목의 주문 상태입니다. 데이터 유형: 문자열
productOrderItem.version	주문 버전. 데이터 유형: 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty:" [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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"
}

제품 주문 오픈 API - PATCH /sn_ind_tmt_orm/order/productOrder/{id}

지정된 고객 주문을 업데이트합니다.

URL 형식

기본 URL: /api/sn_ind_tmt_orm/order/productOrder/{id}

지원되는 요청 매개변수

표 25. 경로 매개변수
이름	설명
id	업데이트할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열

표 26. 쿼리 매개변수
이름	설명
없음

표 27. 요청 본문 매개변수(JSON)
이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]` 업데이트된 테이블/필드: 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
externalId	고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order/의견 기본값: 빈 문자열
주문 통화	주문 및 주문 라인 항목의 통화 코드입니다. 기존 주문의 통화 코드 업데이트는 지원되지 않습니다. 주문과 이미 연결된 통화 코드 이외의 값을 제공하면 업데이트가 거부됩니다. 데이터 유형: 문자열
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item
productOrderItem.action	매개변수를 productOrderItem 사용하는 경우 필수입니다. 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의합니다. 가능한 값: add 변경 삭제 변경 없음 resume 매달다 데이터 유형: 문자열 업데이트된 테이블/필드: 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를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 주: 이전에는 이미 존재했던 외부 제품 인벤토리 ID를 사용하여 PATCH 주문을 생성할 때 작업이 중단되고 오류가 반환되었습니다. 릴리스에서는 Xanadu 기존 외부 제품 인벤토리 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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }` 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }` 업데이트된 테이블: 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 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` 업데이트된 테이블/필드: 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 필드에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOrder항목.제품.장소	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }` 업데이트된 테이블/필드: 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	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` 업데이트된 테이블/필드: 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	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 주: 변경 주문(productOrderItem.action`변경 여부)`은 시스템 속성 값에 따라 다르게 처리됩니다sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. 이 시스템 속성의 값은 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 주문이 처리되는 방식을 결정합니다. 이 시스템 속성을 true(기본값)로 설정하면 참조된 제품 사양을 변경하여 제품 인벤토리가 순서에 있는 버전으로 자동 업그레이드됩니다. 이렇게 하면 주문을 성공적으로 처리할 수 있습니다. 이 시스템 속성이 false로 설정되어 있을 때 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 버전 불일치로 인해 주문이 실패합니다. 데이터 유형: 객체 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` 업데이트된 테이블/필드: 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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 업데이트된 테이블/필드: 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.lastName	연락처의 성입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: 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 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 업데이트된 테이블: 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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` 업데이트된 테이블/필드: 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` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.quantity	주문된 항목 수입니다. 데이터 유형: 숫자 업데이트된 테이블/필드: sn_ind_tmt_orm_order/수량 기본값: 빈 문자열
productOrderItem.revisionOperation	라인 항목에 대해 수행할 업데이트 유형입니다. 이 값이 비어 있으면 기존 라인 항목이 업데이트되거나 새 라인 항목이 추가됩니다(아직 없는 경우). 이 값이 `취소`이면 라인 항목이 취소됩니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

헤더

표 28. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 29. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 30. 상태 코드
상태 코드	설명
201	성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. `다음 주문 항목 특성이 없습니다. 사양을 검토<characteristic.name> 주문을 승인하기 전에 주문 라인 항목의 특성 및 특성 옵션을 수정합니다.` `주문 항목 특성: <characteristic.name> 특성 값: <characteristic.value>이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오.`
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. `잘못된 페이로드: 요청 본문 누락` - 요청 본문에 페이로드가 전달되지 않았습니다. `잘못된 페이로드: productOrderItem 누락` - 제품 주문 라인 항목 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOrderItem ID가 없음` - id 페이로드의 제품 주문 라인 항목에 매개변수가 없습니다. `잘못된 페이로드: productOrderItem 작업 누락` - action 페이로드의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: productOrderItem productOffering 누락` - 페이로드의 제품 주문 라인 항목에서 제품 오퍼링 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOffering id가 누락됨` - id 페이로드의 제품 오퍼링 객체의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: 제품 오퍼링이 없음` - 제품 주문 라인 항목의 제품 오퍼링이 유효하지 않습니다. `잘못된 페이로드: productOrderItem 제품 누락` - 제품 주문 라인 항목의 제품 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 productSpecification이 누락` 됨 - 제품 주문 라인 항목의 제품 사양 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: productSpecification id가 누락` 됨 - id 제품 사양 객체의 제품 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 사양이 없음` - 제품 주문 라인 항목의 제품 사양이 유효하지 않습니다. `잘못된 페이로드: 제품 인벤토리가 없음` - 주문 변경(작업 = 변경)에서 항목 수량이 재고보다 많습니다. `잘못된 페이로드: 제품 인벤토리 ID가 누락됨` - 변경 주문 product.id 에서 페이로드에 누락되었습니다. `잘못된 페이로드: 판매된 제품이 비활성 상태임` - 변경 주문에서 페이로드에 지정된 제품이 비활성 상태입니다. `잘못된 페이로드: relatedParty가 누락됨` - 관련 당사자 객체가 페이로드에서 누락되었습니다. `고객 계정 또는 소비자가 없음` - 관련 당사자, 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 소비자가 없음` - 지정된 관련 당사자 소비자가 인스턴스에 없습니다 ServiceNow . `잘못된 페이로드: 고객 계정이 없음` - 지정된 관련 당사자 고객이 인스턴스에 존재하지 ServiceNow 않습니다. `잘못된 페이로드: 주문 생성 실패` - 요청한 주문을 생성할 수 없습니다. `주문 통화에 대한 기내 수정이 지원되지 않음` - 주문을 생성한 후에는 매개변수를 orderCurrency 업데이트할 수 없습니다. `이 주문은 고객 주문 테이블에서 아직 생성되지 않았습니다. 자세한 내용은 인바운드 큐를 체크인하십시오.` – 입력한 주문 ID가 고객 주문 테이블에 없습니다. `주문의 이행 유형이 "제공"이 아니므로 패치 요청을 할 수 없습니다.` – 배달이 아닌 이행 유형이 있는 주문에 대해 패치 요청이 이루어졌습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
externalId	구매 주문 번호와 같은 고객 주문에 대한 외부 식별자입니다. 데이터 유형: 문자열
href	제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
id	이 요청에 대해 업데이트된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]`
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
주문 통화	주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 주: 이전에는 이미 존재했던 외부 제품 인벤토리 ID를 사용하여 PATCH 주문을 생성할 때 작업이 중단되고 오류가 반환되었습니다. 릴리스에서는 Xanadu 기존 외부 제품 인벤토리 ID가 제공되고 오류가 발생하지 않을 때 이 매개변수가 무시됩니다.
productOrderItem.externalProductInventory.externalProductInventoryId	제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열
productOrderItem.id	라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.itemPrice	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludeAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
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.lastName	연락처의 성입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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"
}

제품 주문 오픈 API - 패치 /sn_ind_tmt_orm/productorder/{id}

지정된 고객 주문을 업데이트합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 제품 주문 오픈 API - PATCH /sn_ind_tmt_orm/order/productOrder/{id}의 새 버전은 입니다.

URL 형식

기본 URL: /api/sn_ind_tmt_orm/productorder/{id}

지원되는 요청 매개변수

표 31. 경로 매개변수
이름	설명
id	업데이트할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열

표 32. 쿼리 매개변수
이름	설명
없음

표 33. 요청 본문 매개변수(JSON)
이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]` 업데이트된 테이블/필드: 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
externalId	고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order/의견 기본값: 빈 문자열
주문 통화	주문 및 주문 라인 항목의 통화 코드입니다. 기존 주문의 통화 코드 업데이트는 지원되지 않습니다. 주문과 이미 연결된 통화 코드 이외의 값을 제공하면 업데이트가 거부됩니다. 데이터 유형: 문자열
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "revisionOperation": "String", "@type": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item
productOrderItem.action	매개변수를 productOrderItem 사용하는 경우 필수입니다. 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의합니다. 가능한 값: add 변경 삭제 변경 없음 resume 매달다 데이터 유형: 문자열 업데이트된 테이블/필드: 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를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]` 주: 이전에는 이미 존재했던 외부 제품 인벤토리 ID를 사용하여 PATCH 주문을 생성할 때 작업이 중단되고 오류가 반환되었습니다. 릴리스에서는 Xanadu 기존 외부 제품 인벤토리 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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }` 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }` 업데이트된 테이블: 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 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` 업데이트된 테이블/필드: 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 필드에 있습니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOrder항목.제품.장소	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }` 업데이트된 테이블/필드: 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	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` 업데이트된 테이블/필드: 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	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 주: 변경 주문(productOrderItem.action`변경 여부)`은 시스템 속성 값에 따라 다르게 처리됩니다sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. 이 시스템 속성의 값은 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 주문이 처리되는 방식을 결정합니다. 이 시스템 속성을 true(기본값)로 설정하면 참조된 제품 사양을 변경하여 제품 인벤토리가 순서에 있는 버전으로 자동 업그레이드됩니다. 이렇게 하면 주문을 성공적으로 처리할 수 있습니다. 이 시스템 속성이 false로 설정되어 있을 때 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 버전 불일치로 인해 주문이 실패합니다. 데이터 유형: 객체 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` 업데이트된 테이블/필드: 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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 업데이트된 테이블/필드: 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.lastName	연락처의 성입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: 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 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 업데이트된 테이블: 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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` 업데이트된 테이블/필드: 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` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.quantity	주문된 항목 수입니다. 데이터 유형: 숫자 업데이트된 테이블/필드: sn_ind_tmt_orm_order/수량 기본값: 빈 문자열
productOrderItem.revisionOperation	라인 항목에 대해 수행할 업데이트 유형입니다. 이 값이 비어 있으면 기존 라인 항목이 업데이트되거나 새 라인 항목이 추가됩니다(아직 없는 경우). 이 값이 `취소`이면 라인 항목이 취소됩니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

헤더

표 34. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 35. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 36. 상태 코드
상태 코드	설명
201	성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. `다음 주문 항목 특성이 없습니다. 사양을 검토<characteristic.name> 주문을 승인하기 전에 주문 라인 항목의 특성 및 특성 옵션을 수정합니다.` `주문 항목 특성: <characteristic.name> 특성 값: <characteristic.value>이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오.`
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. `잘못된 페이로드: 요청 본문 누락` - 요청 본문에 페이로드가 전달되지 않았습니다. `잘못된 페이로드: productOrderItem 누락` - 제품 주문 라인 항목 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOrderItem ID가 없음` - id 페이로드의 제품 주문 라인 항목에 매개변수가 없습니다. `잘못된 페이로드: productOrderItem 작업 누락` - action 페이로드의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: productOrderItem productOffering 누락` - 페이로드의 제품 주문 라인 항목에서 제품 오퍼링 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOffering id가 누락됨` - id 페이로드의 제품 오퍼링 객체의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: 제품 오퍼링이 없음` - 제품 주문 라인 항목의 제품 오퍼링이 유효하지 않습니다. `잘못된 페이로드: productOrderItem 제품 누락` - 제품 주문 라인 항목의 제품 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 productSpecification이 누락` 됨 - 제품 주문 라인 항목의 제품 사양 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: productSpecification id가 누락` 됨 - id 제품 사양 객체의 제품 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 사양이 없음` - 제품 주문 라인 항목의 제품 사양이 유효하지 않습니다. `잘못된 페이로드: 제품 인벤토리가 없음` - 주문 변경(작업 = 변경)에서 항목 수량이 재고보다 많습니다. `잘못된 페이로드: 제품 인벤토리 ID가 누락됨` - 변경 주문 product.id 에서 페이로드에 누락되었습니다. `잘못된 페이로드: 판매된 제품이 비활성 상태임` - 변경 주문에서 페이로드에 지정된 제품이 비활성 상태입니다. `잘못된 페이로드: relatedParty가 누락됨` - 관련 당사자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 고객 계정 또는 소비자가 없음` - 관련 당사자 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 소비자가 없음` - 지정된 관련 당사자 소비자가 인스턴스에 없습니다 ServiceNow . `잘못된 페이로드: 고객 계정이 없음` - 지정된 관련 당사자 고객이 인스턴스에 존재하지 ServiceNow 않습니다. `잘못된 페이로드: 주문 생성 실패` - 요청한 주문을 생성할 수 없습니다. `잘못된 페이로드: 이 주문은 고객 주문 테이블에서 아직 생성되지 않았습니다. 자세한 내용은 인바운드 큐를 체크인하십시오.` - 아직 고객 주문 테이블에 없는 주문에 대한 패치 요청이 이루어졌습니다. 주문은 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에서 스케줄러가 처리할 기록을 선택하기를 기다리고 있습니다. `잘못된 페이로드: 주문 이행 유형이 "제공"이 아니기 때문에 패치 요청을 할 수 없습니다.` - 주문 처리 유형이 아닌 deliver 주문에 대한 패치 요청이 이루어졌습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
id	이 요청에 대해 업데이트된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열
externalId	구매 주문 번호와 같은 고객 주문에 대한 외부 식별자입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]`
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "actionReason": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludeAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty": [ { "email": "String", "firstName": "String", "id": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
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.lastName	연락처의 성입니다. 데이터 유형: 문자열 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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

지원되는 요청 매개변수

표 37. 경로 매개변수
이름	설명
없음

표 38. 쿼리 매개변수
이름	설명
없음

표 39. 요청 본문 매개변수(JSON)
이름	설명
cancellationReason (영문)	취소 사유입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOrder	제품 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	필수 취소할 고객 주문의 Sys_id입니다. 고객 주문 [sn_ind_tmt_orm_order] 테이블에 있습니다. 데이터 유형: 문자열
productOrder.href	취소할 고객 주문의 URL입니다. 데이터 유형: 문자열 기본값: 빈 문자열
productOrder.@referredType	이 매개 변수의 값은 `ProductOrder`여야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열
요청취소날짜	주문을 취소할 날짜입니다. 데이터 유형: 문자열 기본값: 빈 문자열
@type	이 매개 변수의 값은 `CancelProductOrder`여야 합니다. 데이터 유형: 문자열 기본값: 빈 문자열

헤더

표 40. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 41. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 42. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. 페이로드가 비어 있습니다. 잘못된 페이로드입니다. 필수 필드 누락: <필드 이름>. 잘못된 주문 ID입니다. 잘못된 주문 ID: `이 주문은 고객 주문 테이블에서 아직 생성되지 않았습니다`. 아직 생성되지 않은 주문에 대한 취소 요청이 이루어졌습니다. 주문은 인바운드 큐[sn_tmt_core_inbound_queue] 테이블에서 스케줄러가 기록을 선택할 때까지 기다리고 있습니다.

응답 본문 매개변수(JSON)


이름	설명
cancellationReason (영문)	취소 사유입니다. 데이터 유형: 문자열
href	취소된 주문의 URL입니다. 데이터 유형: 문자열
id	취소된 주문의 Sys_id입니다. 데이터 유형: 문자열
productOrder	제품 주문에 대한 데이터를 포함합니다. 데이터 유형: 객체 `"productOrder": { "id": "String", "href": "String", "@referredType": "String" }`
productOrder.id	취소된 주문의 Sys_id입니다. 데이터 유형: 문자열
productOrder.href	취소된 주문의 URL입니다. 데이터 유형: 문자열
productOrder.@referredType	이 매개 변수의 값은 `ProductOrder`입니다. 데이터 유형: 문자열
요청취소날짜	주문을 취소할 날짜입니다. 데이터 유형: 문자열
상태	취소의 상태입니다. 취소 요청이 성공적으로 처리되면(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

지원되는 요청 매개변수

표 43. 경로 매개변수
이름	설명
없음

표 44. 쿼리 매개변수
이름	설명
모드	비동기 주문 처리를 활성화합니다. 그러면 생성할 인바운드 큐[sn_tmt_core_inbound_queue] 테이블에 주문이 추가됩니다. 포함되지 않은 경우 주문은 동기적으로 처리됩니다. 가능한 값: async 데이터 유형: 문자열

표 45. 요청 본문 매개변수(JSON)
이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]` 업데이트된 테이블/필드: 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
externalId	고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
메모	고객이 주문할 때 작성한 추가 메모를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order
note.text	필수 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order/의견 기본값: 빈 문자열
주문 통화	필수 주문 및 주문 라인 항목의 통화 코드입니다. 통화는 주문 및 주문 라인 항목의 모든 요소에 대해 동일해야 하며, 그렇지 않으면 오류가 반환되고 주문이 생성되지 않습니다. 주문이 생성되면 통화 코드를 변경할 수 없습니다. 데이터 유형: 문자열
productOrderItem	필수 제품 주문 및 관련 작업과 연결된 항목을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item
productOrderItem.action	필수 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의합니다. 가능한 값: add 변경 삭제 변경 없음 resume 매달다 데이터 유형: 문자열 업데이트된 테이블/필드: 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를 포함하는 객체의 배열입니다. 데이터 형식: 개체 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }` 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }` 업데이트된 테이블: 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 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` 업데이트된 테이블/필드: 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	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }` 업데이트된 테이블/필드: 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	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` 업데이트된 테이블/필드: 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	업데이트가 주문 변경용인 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productSpecification	필수 제품과 연결된 제품 사양에 대한 설명입니다. 주: 변경 주문(productOrderItem.action`변경 여부)`은 시스템 속성 값에 따라 다르게 처리됩니다sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. 이 시스템 속성의 값은 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 주문이 처리되는 방식을 결정합니다. 이 시스템 속성을 true(기본값)로 설정하면 참조된 제품 사양을 변경하여 제품 인벤토리가 순서에 있는 버전으로 자동 업그레이드됩니다. 이렇게 하면 주문을 성공적으로 처리할 수 있습니다. 이 시스템 속성이 false로 설정되어 있을 때 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 버전 불일치로 인해 주문이 실패합니다. 데이터 유형: 객체 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` 업데이트된 테이블/필드: 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에 연결된 파티 역할을 설명하는 개체의 배열입니다. 데이터 유형: 배열 `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 업데이트된 테이블/필드: 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.lastName	연락처의 성입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: 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 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	필수 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 업데이트된 테이블: 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	필수 주문 항목 간의 상위/하위 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` 업데이트된 테이블/필드: 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": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

헤더

표 46. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 47. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 48. 상태 코드
상태 코드	설명
201	성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. `다음 주문 항목 특성이 없습니다. 사양을 검토<characteristic.name> 주문을 승인하기 전에 주문 라인 항목의 특성 및 특성 옵션을 수정합니다.` `주문 항목 특성: <characteristic.name> 특성 값: <characteristic.value>이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오.`
202	허용. 비동기 모드에서 주문에 대한 성공적인 요청입니다. 즉, 매개변수가 mode`async` 로 설정되어 요청이 이루어졌고 기록이 인바운드 큐 [sn_tmt_core_inbound_queue] 테이블에서 처리되도록 예약되었습니다.
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. `잘못된 페이로드: 요청 본문 누락` - 요청 본문에 페이로드가 전달되지 않았습니다. `잘못된 페이로드: productOrderItem 누락` - 제품 주문 라인 항목 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOrderItem ID가 없음` - id 페이로드의 제품 주문 라인 항목에 매개변수가 없습니다. `잘못된 페이로드: productOrderItem 작업 누락` - action 페이로드의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: productOrderItem productOffering 누락` - 페이로드의 제품 주문 라인 항목에서 제품 오퍼링 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOffering id가 누락됨` - id 페이로드의 제품 오퍼링 객체의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: 제품 오퍼링이 없음` - 제품 주문 라인 항목의 제품 오퍼링이 유효하지 않습니다. `잘못된 페이로드: productOrderItem 제품 누락` - 제품 주문 라인 항목의 제품 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 productSpecification이 누락` 됨 - 제품 주문 라인 항목의 제품 사양 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: productSpecification id가 누락` 됨 - id 제품 사양 객체의 제품 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 사양이 없음` - 제품 주문 라인 항목의 제품 사양이 유효하지 않습니다. `잘못된 페이로드: 제품 인벤토리가 없음` - 주문 변경(작업 = 변경)에서 항목 수량이 재고보다 많습니다. `잘못된 페이로드: 제품 인벤토리 ID가 누락됨` - 변경 주문 product.id 에서 페이로드에 누락되었습니다. `잘못된 페이로드: 판매된 제품이 비활성 상태임` - 변경 주문에서 페이로드에 지정된 제품이 비활성 상태입니다. `잘못된 페이로드: relatedParty가 누락됨` - 관련 당사자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 고객 계정 또는 소비자가 없음` - 관련 당사자 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 소비자가 없음` - 지정된 관련 당사자 소비자가 인스턴스에 없습니다 ServiceNow . `잘못된 페이로드: 고객 계정이 없음` - 지정된 관련 당사자 고객이 인스턴스에 존재하지 ServiceNow 않습니다. `잘못된 페이로드: 주문 생성 실패` - 요청한 주문을 생성할 수 없습니다. `잘못된 페이로드: orderCurrency가 필요함` - 매개변수가 orderCurrency 페이로드에서 누락되었습니다. `비활성 통화 코드: <currency>` - 제공된 통화가 인스턴스에서 ServiceNow 비활성 상태입니다. `하나 이상의 광고 항목에 주문 통화와 다른 통화 코드가 있음` - 모든 광고 항목에 주문 통화와 동일한 통화 코드가 없습니다. `주문 통화에 대한 기내 수정이 지원되지 않음` - 주문을 생성한 후에는 매개변수를 orderCurrency 업데이트할 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
committedDueDate	주문에 대해 작업을 수행해야 하는 날짜 및 시간입니다. 이 값은 각 주문 라인 항목의 값과 같거나 이후 committedDueDate 여야 합니다. 데이터 유형: 문자열
externalId	구매 주문 번호와 같은 고객 주문에 대한 외부 식별자입니다. 데이터 유형: 문자열
href	제품 주문 기록에 대한 상대 링크입니다. 데이터 유형: 문자열
id	이 요청에 대해 생성된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]`
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
주문 통화	주문 및 주문 라인 항목의 통화 코드입니다. 데이터 유형: 문자열
orderId	생성할 주문의 Sys_id입니다. 요청이 성공하면 처리할 일정에 따라 인바운드 큐[sn_tmt_core_inbound_queue] 테이블에 주문이 추가됩니다. 주: 이 값은 쿼리의 매개변수를 사용하여 주문이 비동기적으로 생성된 경우의 mode 유일한 결과입니다. `{ "orderId": "b0fc877ac3ab5110856d73ce3640dde0" }` 데이터 유형: 문자열
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
productOrderItem.externalProductInventory.externalProductInventoryId	제품 인벤토리에 매핑된 외부 ID입니다. 데이터 유형: 문자열
productOrderItem.id	라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.itemPrice	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludeAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다.이 매개변수는 `change` 또는 `delete`인 경우에만 productOrderItem.action 반환됩니다. sys_id와 external_id가 모두 있으면 external_id가 반환됩니다. 데이터 유형: 문자열
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productRelationship	주문 라인 항목에 대한 제품 관계 상세 정보 목록입니다. 데이터 유형: 배열 `"productRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.firstName	연락처의 이름입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.lastName	연락처의 성입니다. 데이터 유형: 문자열 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering:" { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
productOrderItem.productOrderItemRelationship.id	관련 라인 항목의 고유 식별자입니다. 주문 라인 항목 [sn_ind_tmt_orm_order_line_item] 테이블의 sn_ind_tmt_orm_external_id 필드에 있습니다. 데이터 유형: 문자열
productOrderItem.productOrderItemRelationship.relationshipType	두 광고 항목 간의 관계 유형입니다. 이 정보는 관계 계층 구조를 식별하는 데 사용됩니다. 가능한 값: 하일드 부모 존재 여부 필수 `HasChild` 및 `HasParent` 는 부모/자식 관계에 사용됩니다. `필수` 는 수평 관계에 사용됩니다(라인 항목에 다른 라인 항목이 필요함). 데이터 유형: 문자열
productOrderItem.quantity	주문할 관련 항목 수입니다. 데이터 유형: 숫자
productOrderItem.state	제품 주문 항목의 현재 상태입니다. 이 값은 항상 `새로운` 값입니다. 데이터 유형: 문자열
productOrderItem.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrderItem`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
관련파티	주문에 대한 접촉 창구 목록입니다. 각 접점은 배열의 개체입니다. 고객 계정 또는 소비자 계정 정보가 포함된 항목을 하나 이상 나열해야 합니다. 데이터 유형: 배열 `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다. 데이터 유형: 문자열
relatedParty.name	계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열
relatedParty.type	고객 유형입니다. 가능한 값: 소비자 고객 고객 연락처 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열
requestedStartDate	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열
상태	주문의 현재 상태입니다. 이 엔드포인트의 경우 이 값은 항상 `new`입니다. 데이터 유형: 문자열
@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `ProductOrder`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

비동기적으로 처리

이 예제에서는 쿼리 매개 변수를 사용하여 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

지정된 고객 주문 및 고객 주문 라인 항목을 생성합니다.

중요사항:

릴리스부터 Tokyo 이 엔드포인트는 더 이상 사용되지 않습니다. 이 엔드포인트 제품 주문 오픈 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]

URL 형식

기본 URL: /api/sn_ind_tmt_orm/productorder

지원되는 요청 매개변수

표 49. 경로 매개변수
이름	설명
없음

표 50. 쿼리 매개변수
이름	설명
없음

표 51. 요청 본문 매개변수(JSON)
이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]` 업데이트된 테이블/필드: 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
externalId	고객 주문의 고유 식별자입니다. 이 값은 외부 시스템에 의해 결정됩니다. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order/external_id 기본값: 빈 문자열
href	자원 기록에 대한 상대 링크입니다. 데이터 유형: 문자열 기본값: 빈 문자열
메모	고객이 주문할 때 작성한 추가 메모를 포함하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order
note.text	필수 고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: sn_ind_tmt_orm_order/의견 기본값: 빈 문자열
주문 통화	필수 주문 및 주문 라인 항목의 통화 코드입니다. 통화는 주문 및 주문 라인 항목의 모든 요소에 대해 동일해야 하며, 그렇지 않으면 오류가 반환되고 주문이 생성되지 않습니다. 주문이 생성되면 통화 코드를 변경할 수 없습니다. 데이터 유형: 문자열
productOrderItem	필수 제품 주문 및 관련 작업과 연결된 항목을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItem": [ { "action": "String", "actionReason": "String", "committedDueDate": "String", "externalProductInventory": [Array], "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemRelationship": [Array], "quantity": Number, "@type": "String" } ]` 업데이트된 테이블/필드: sn_ind_tmt_orm_order_line_item
productOrderItem.action	필수 제품에 대해 수행할 작업입니다. 가능한 작업은 sn_ind_tmt_orm_order_line_item 테이블의 작업 딕셔너리 항목에 있는 선택 목록 탭에서 정의합니다. 가능한 값: add 변경 삭제 변경 없음 resume 매달다 데이터 유형: 문자열 업데이트된 테이블/필드: 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를 포함하는 객체의 배열입니다. 데이터 형식: 개체 배열 `"externalProductInventory": [ { "externalProductInventoryId": "String" } ]`
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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]` 업데이트된 테이블: sn_ind_tmt_orm_order 기본값: 빈 문자열
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }` 업데이트된 테이블: sn_ind_tmt_orm_order_line_item 기본값: 빈 문자열
productOrderItem.itemPrice.price.taxIncludedAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }` 업데이트된 테이블: 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 필요합니다. 고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }` 업데이트된 테이블/필드: 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	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }` 업데이트된 테이블/필드: 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	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]` 업데이트된 테이블/필드: 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	업데이트가 주문 변경용인 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/previous_characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열 테이블/필드 업데이트됨: sn_ind_tmt_orm_order_characteristic_value/characteristic_option_value 기본값: 빈 문자열
productOrderItem.product.productSpecification	필수 제품과 연결된 제품 사양에 대한 설명입니다. 주: 변경 주문(productOrderItem.action`변경 여부)`은 시스템 속성 값에 따라 다르게 처리됩니다sn_ind_tmt_orm.allowSpecVersionUpdateInChangeOrder. 이 시스템 속성의 값은 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 주문이 처리되는 방식을 결정합니다. 이 시스템 속성을 true(기본값)로 설정하면 참조된 제품 사양을 변경하여 제품 인벤토리가 순서에 있는 버전으로 자동 업그레이드됩니다. 이렇게 하면 주문을 성공적으로 처리할 수 있습니다. 이 시스템 속성이 false로 설정되어 있을 때 제품 인벤토리가 주문에 표시된 것과 다른 버전인 경우 버전 불일치로 인해 주문이 실패합니다. 데이터 유형: 객체 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }` 업데이트된 테이블/필드: 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에 연결된 파티 역할을 설명하는 개체의 배열입니다. 데이터 유형: 배열 `"relatedParty": [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]` 업데이트된 테이블/필드: 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.lastName	연락처의 성입니다. 데이터 유형: 문자열 업데이트된 테이블/필드: 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 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	필수 제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }` 업데이트된 테이블: 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	필수 주문 항목 간의 상위/하위 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]` 업데이트된 테이블/필드: 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": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
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`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열

헤더

표 52. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. application/json만 지원합니다.
컨텐츠-형식	요청 본문의 데이터 형식입니다. application/json만 지원합니다.

표 53. 응답 헤더
헤더	설명
컨텐츠-형식	응답 본문의 데이터 형식입니다. 는 만 지원합니다 application/json.

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 54. 상태 코드
상태 코드	설명
201	성공입니다. 특성 또는 특성 옵션 정보에 문제가 있는 경우 엔드포인트는 연결된 고객 주문 라인 항목 기록의 작업 메모 필드에 다음 설명을 저장합니다. `다음 주문 항목 특성이 없습니다. 사양을 검토<characteristic.name> 주문을 승인하기 전에 주문 라인 항목의 특성 및 특성 옵션을 수정합니다.` `주문 항목 특성: <characteristic.name> 특성 값: <characteristic.value>이 잘못되었습니다. 주문을 승인하기 전에 특성 값을 수정하십시오.`
400	잘못된 요청입니다. 다음 이유 중 하나일 수 있습니다. `잘못된 페이로드: 요청 본문 누락` - 요청 본문에 페이로드가 전달되지 않았습니다. `잘못된 페이로드: productOrderItem 누락` - 제품 주문 라인 항목 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOrderItem ID가 없음` - id 페이로드의 제품 주문 라인 항목에 매개변수가 없습니다. `잘못된 페이로드: productOrderItem 작업 누락` - action 페이로드의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: productOrderItem productOffering 누락` - 페이로드의 제품 주문 라인 항목에서 제품 오퍼링 객체 또는 JSON이 누락되었습니다. `잘못된 페이로드: productOffering id가 누락됨` - id 페이로드의 제품 오퍼링 객체의 제품 주문 라인 항목에 매개변수가 누락되었습니다. `잘못된 페이로드: 제품 오퍼링이 없음` - 제품 주문 라인 항목의 제품 오퍼링이 유효하지 않습니다. `잘못된 페이로드: productOrderItem 제품 누락` - 제품 주문 라인 항목의 제품 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 productSpecification이 누락` 됨 - 제품 주문 라인 항목의 제품 사양 객체 또는 JSON이 페이로드에서 누락되었습니다. `잘못된 페이로드: productSpecification id가 누락` 됨 - id 제품 사양 객체의 제품 주문 라인 항목에 있는 매개변수가 페이로드에서 누락되었습니다. `잘못된 페이로드: 제품 사양이 없음` - 제품 주문 라인 항목의 제품 사양이 유효하지 않습니다. `잘못된 페이로드: 제품 인벤토리가 없음` - 주문 변경(작업 = 변경)에서 항목 수량이 재고보다 많습니다. `잘못된 페이로드: 제품 인벤토리 ID가 누락됨` - 변경 주문 product.id 에서 페이로드에 누락되었습니다. `잘못된 페이로드: 판매된 제품이 비활성 상태임` - 변경 주문에서 페이로드에 지정된 제품이 비활성 상태입니다. `잘못된 페이로드: relatedParty가 누락됨` - 관련 당사자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 고객 계정 또는 소비자가 없음` - 관련 당사자 고객 또는 소비자 객체가 페이로드에서 누락되었습니다. `잘못된 페이로드: 소비자가 없음` - 지정된 관련 당사자 소비자가 인스턴스에 없습니다 ServiceNow . `잘못된 페이로드: 고객 계정이 없음` - 지정된 관련 당사자 고객이 인스턴스에 존재하지 ServiceNow 않습니다. `잘못된 페이로드: 주문 생성 실패` - 요청한 주문을 생성할 수 없습니다.

응답 본문 매개변수(JSON)


이름	설명
채널	제품 판매에 사용할 채널을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"channel": [ { "id": "String", "name": "String" } ]`
channel.id	연결된 제품을 판매하는 데 사용할 채널의 고유 식별자입니다. 채널 ID 값은 배포 채널 [sn_prd_pm_distribution_channel] 테이블의 external_id 필드에 있습니다. 데이터 유형: 문자열
channel.name	연결된 제품을 판매하는 데 사용할 채널의 이름입니다. 데이터 유형: 문자열
id	이 요청에 대해 생성된 고객 주문의 Sys_id입니다. 데이터 유형: 문자열
externalId	구매 주문 번호와 같은 고객 주문에 대한 외부 식별자입니다. 데이터 유형: 문자열
메모	고객이 주문할 때 작성한 추가 메모를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"note": [ { "text": "String" } ]`
note.text	고객이 주문하는 동안 작성한 추가 메모/설명입니다. 데이터 유형: 문자열
productOrderItem	제품 주문 및 관련 작업과 연결된 항목을 설명하는 목록입니다. 데이터 유형: 배열 `"productOrderItem:" [ { "action": "String", "id": "String", "itemPrice": [Array], "product": {Object}, "productOffering": {Object}, "productOrderItemReleationship": [Array], "quantity": Number, "state": "String", "@type": "String" } ]`
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	제품과 연결된 가격을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"itemPrice": [ { "price": {Object}, "priceType": "String", "recurringChargePeriod": "String" } ]`
productOrderItem.itemPrice.price	관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"price": { "taxIncludedAmount": {Object} }`
productOrderItem.itemPrice.price.taxIncludeAmount	세금을 포함하여 관련 제품의 가격에 대한 설명입니다. 데이터 유형: 객체 `"taxIncludedAmount": { "unit": "String", "value": Number }`
productOrderItem.itemPrice.price.taxIncludeAmount.unit	가격이 표시되는 통화 코드입니다. 데이터 유형: 문자열
productOrderItem.itemPrice.price.taxIncludeAmount.value	세금을 포함한 제품 가격입니다. 데이터 유형: 숫자
productOrderItem.itemPrice.priceType	항목 가격의 유형입니다(반복 또는 비반복). 데이터 유형: 문자열
productOrderItem.itemPrice.recurringChargePeriod	가격이 반복되는 경우 반복 기간( `예: 월`)입니다. 데이터 유형: 문자열
productOrderItem.product	고객이 구매한 제품의 인스턴스 상세 정보에 대한 설명입니다. 데이터 유형: 객체 `"product": { "id": "String", "place": {Object}, "productCharacteristic": [Array], "productSpecification": {Object}, "relatedParty": {Object}, "@type": "String" }`
productOrderItem.product.id	판매된 제품의 고유 식별자입니다. 제품 인벤토리 [sn_ind_tmt_orm_product_inventory] 테이블의 sys_id 또는 sn_ind_tmt_orm_external_id 필드에 있습니다.이 매개변수는 `change` 또는 `delete`인 경우에만 productOrderItem.action 반환됩니다. sys_id와 external_id가 모두 있으면 external_id가 반환됩니다. 데이터 유형: 문자열
productOrderItem.product.place	제품을 설치할 위치의 맵입니다. 데이터 유형: 객체 `"place": { "id": "String", "@type": "String" }`
productOrderItem.product.place.id	위치[cmn_location] 테이블에 있는 연결된 위치 기록의 Sys_id입니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic	연결된 제품의 특성을 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productCharacteristic": [ { "name": "String", "previousValue": "String", "value": "String" } ]`
productOrderItem.product.productCharacteristic.name	제품과 연결할 특성 기록의 이름입니다. 특성 [sn_prd_pm_characteristic] 테이블에 있습니다. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.previousValue	업데이트가 변경 주문에 대한 경우의 이전 특성 옵션 값입니다. 매개변수가 productOrderItem.action`add`가 아닌 경우 요청은 변경 주문입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productCharacteristic.value	제품과 연결된 특성 옵션 값입니다. 특성 옵션 값에 대한 자세한 내용은 을 참조하십시오 Create product characteristics and characteristic options. 데이터 유형: 문자열
productOrderItem.product.productSpecification	제품과 연결된 제품 사양에 대한 설명입니다. 데이터 유형: 객체 `"productSpecification": { "id": "String", "internalVersion": "String", "name": "String", "version": "String", "@type": "String" }`
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	광고 항목의 연락처 목록입니다. 데이터 유형: 배열 `"relatedParty:" [ { "email": "String", "firstName": "String", "lastName": "String", "phone": "String", "@referredType": "String", "@type": "String" } ]`
productOrderItem.product.relatedParty.email	접촉 창구의 이메일 주소입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.firstName	연락처의 이름입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.lastName	연락처의 성입니다. 데이터 유형: 문자열 데이터 유형: 문자열
productOrderItem.product.relatedParty.phone	연락처의 직장 전화 번호입니다. 데이터 유형: 문자열
productOrderItem.product.relatedParty.@referredType	고객 유형입니다. 가능한 값: OrderLineItemContact 데이터 유형: 문자열
productOrderItem.product.relatedParty.@type	TMF Open API 표준의 일부입니다. 주문 라인 항목 연락처에 대한 주석입니다. 이 값은 항상 `RelatedParty`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.product.@type	TMF Open API 표준의 일부입니다. 제품에 대한 주석입니다. 이 값은 항상 `제품`입니다. 이 정보는 저장되지 않습니다. 데이터 유형: 문자열
productOrderItem.productOffering	제품과 연결된 제품 오퍼링에 대한 설명입니다. 데이터 유형: 객체 `"productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" }`
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	주문 라인 항목 간의 관계를 설명하는 객체의 배열입니다. 데이터 유형: 배열 `"productOrderItemRelationship": [ { "id": "String", "relationshipType": "String" } ]`
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": "String", "name": "String", "@referredType": "String", "@type": "String" } ]`
relatedParty.id	주문과 관련된 계정, 고객 접촉 창구 또는 소비자의 Sys_id 또는 external_id입니다. 계정 [customer_account], 연락처 [customer_contact] 테이블 또는 소비자 [csm_consumer] 테이블에 있습니다. 데이터 유형: 문자열
relatedParty.name	계정, 고객 또는 소비자의 이름입니다. 데이터 유형: 문자열
relatedParty.type	고객 유형입니다. 가능한 값: 소비자 고객 고객 연락처 데이터 유형: 문자열
requestedCompletionDate	고객이 요청한 배송 날짜입니다. 데이터 유형: 문자열
requestedStartDate	고객이 요청한 주문 시작 날짜입니다. 데이터 유형: 문자열
상태	주문의 현재 상태입니다. 이 엔드포인트의 경우 이 값은 항상 `new`입니다. 데이터 유형: 문자열
@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"
}