---
sourceDocument: Xanadu API 참조
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- ko-KR
ft:publication_title :
- Xanadu API 참조
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# 주문 API
# 주문 API {#ariaid-title1}
* 릴리스 버전: Xanadu
*
* 업데이트 날짜 2024년 08월 01일
*
*  소요 시간: 52분
주문 API는 애플리케이션의 주문 라인 항목이 포함된 주문을 검색하고 생성하기 위한 엔드포인트를 고객 서비스 관리 제공합니다.
이 API에는 주문 관리 (app-csm-order-mgmt) 스토어 애플리케이션이 필요하며 `sn_csm_order_mgmt` 네임스페이스 내에서 제공됩니다. 자세한 내용은 [Sales Customer Relationship Management](https://www.servicenow.com/docs/access?context=order-mgt-overview&version=xanadu&pubname=xanadu-order-management&ft:locale=en-US) 문서를 참조하십시오.
이 API에 액세스하려면 sn_csm_om.order_integrator가 필요하며 다음 중 하나가 필요합니다.
* sn_csm_om.consumer_agent -- API 쓰기 액세스는 B2C 주문으로 제한됩니다.
* sn_csm_om.customer_agent -- API 쓰기 액세스는 B2B 주문으로 제한됩니다.
* sn_csm_om.order_admin -- B2B 또는 B2C 주문에 대한 API 쓰기 액세스 권한입니다.
{#order_csm-api__ul_gfd_tfn_ctb}
B2B 및 B2C 주문에 대한 자세한 내용은 [B2B2C용 고객 데이터 모델을](https://www.servicenow.com/docs/access?context=customer-data-model-b2b2c&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) 참조하세요.
## 주문 API -- GET /sn_csm_order_mgmt/order/{id} {#ariaid-title2}
sys_id 또는 주문 번호를 지정하여 전체 주문 상세 정보를 검색합니다.
### URL 형식
버전이 지정된 URL: /api/sn_csm_order_mgmt/{api_version}/order/{id}
기본 URL: /api/sn_csm_order_mgmt/order/{id}
### 지원되는 요청 매개변수
{#order_csm-GET__entry__2}{#order_csm-GET__version-RESTAPI}
| 이름 | 설명 |
|-|-|
| api_version | 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열 |
| id | 주문 \[sn_csm_om_order\] 테이블에 있는 검색할 기록의 Sys_id 또는 order_id(주문 번호)입니다. 데이터 유형: 문자열 |
[표 1. 경로 매개변수]
{#order_csm-GET__entry__8}
| 이름 | 설명 |
|-|-|
| sysparm_display_value | 참조 필드의 표시 값을 표시할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 응답에 참조 필드, 선택 필드 및 날짜 필드의 표시 값을 표시합니다. * false: 응답에 참조 필드, 선택 필드 및 날짜 필드의 실제 값을 표시합니다. {#order_csm-GET__ul_hn1_jdp_1tb} 기본값: false |
[표 2. 쿼리 매개변수]
{#order_csm-GET__entry__12}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 3. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#order_csm-GET__entry__16}{#order_csm-GET__accept-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
[표 4. 요청 헤더]
{#order_csm-GET__entry__20}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 5. 응답 헤더]
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#order_csm-GET__entry__24}{#order_csm-GET__entry-200-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 401 | 사용자가 인증되지 않았습니다. |
| 403 | 사용자에게 권한이 없습니다. * 사용자에게 API에 액세스하는 데 필요한 역할이 없습니다. * 사용자에게 주문을 읽을 수 있는 권한이 없습니다. {#order_csm-GET__ul_ktg_jfp_1tb} 이 API에 액세스하려면 sn_csm_om.order_integrator가 필요하며 다음 중 하나가 필요합니다. * sn_csm_om.consumer_agent -- API 쓰기 액세스는 B2C 주문으로 제한됩니다. * sn_csm_om.customer_agent -- API 쓰기 액세스는 B2B 주문으로 제한됩니다. * sn_csm_om.order_admin -- B2B 또는 B2C 주문에 대한 API 쓰기 액세스 권한입니다. {#order_csm-GET__ul_gfd_tfn_ctb} |
[표 6. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
{#order_csm-GET__entry__32}{#order_csm-GET__ordr-ph-order_li}{#order_csm-GET__ordr-ph-order_li-account}{#order_csm-GET__ordr-ph-unit_of_meas}
| 이름 | 설명 |
|-|-|
| 계정 | 계정 \[customer_account\] 테이블에 있는 기록의 Sys_id입니다. B2B 주문에 대한 계정을 식별합니다. 데이터 유형: 문자열 |
| actual_end_date | 주문의 종료 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| actual_start_date | 주문 시작 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| billing_city | 청구 도시의 이름입니다. 데이터 유형: 문자열 |
| billing_country | 청구 국가의 약어입니다. 데이터 유형: 문자열 |
| billing_state | 청구 시/도의 약어입니다. 데이터 유형: 문자열 |
| billing_street | 청구지 주소입니다. 데이터 유형: 문자열 |
| billing_zip | 청구 우편 번호입니다. 데이터 유형: 문자열 |
| 설명 | 주문에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 소비자 | 소비자 \[csm_consumer\] 테이블에 있는 기록의 Sys_id입니다. B2C 주문의 소비자를 식별합니다. 데이터 유형: 문자열 |
| 연락처 | 계정과 관련된 고객 접촉 창구의 Sys_id입니다. 접촉 창구 \[customer_contact\] 테이블에 나열됩니다. 데이터 유형: 문자열 |
| 계약 | 계약 \[ast_contract\] 테이블에 나열된 계약의 고객 서비스 Sys_id입니다. 데이터 유형: 문자열 |
| 오류 | 요청 프로세스 중에 발생한 오류를 설명하는 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } |
| 오류.상세 정보 | 요청 프로세스 중에 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 요청 프로세스 중에 발생한 오류에 대한 메시지입니다. 각 오류 메시지에는 속성에 해당 설명이 detail 있습니다. 데이터 유형: 문자열 |
| expected_end_date | 주문의 예상 종료 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| expected_start_date | 주문의 예상 시작 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| external_id | 외부 공급업체 시스템의 관련 기록을 나타내는 외부 ID입니다. 데이터 유형: 문자열 |
| external_system | 고객 시스템의 이름입니다. 데이터 유형: 문자열 |
| order_category | 고객 주문 유형입니다. 가능한 값: * 제품 * 서비스 {#order_csm-GET__d3782e287} 데이터 유형: 문자열 |
| order_currency | 주문을 구매한 통화를 나타내는 통화 코드입니다. 예를 들어 미국 달러의 경우 USD 입니다. 이 통화는 주문 및 라인 주문의 모든 금액 필드에 사용됩니다. 통화 코드는 통화 \[fx_currency\] 테이블에 나열됩니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_date | 주문이 생성된 날짜 및 시간입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| order_id | 주문 \[sn_csm_om_order\] 테이블에 나열된 주문의 주문 번호입니다. 데이터 유형: 문자열 |
| order_line_items | 필수 주문의 각 주문 라인 항목을 정의하는 객체 목록입니다. 주문 라인 항목 \[sn_csm_om_order_line_item\] 테이블에 있습니다. 데이터 유형: 배열 각 주문 라인 항목 객체의 필수 속성: * account B2B 주문 또는 consumer B2C 주문의 경우.{#order_csm-GET__ordr-ph-order_li-acct-cons} * product_offering -- * quantity * unit_of_measurements * order_line_characteristics {#order_csm-GET__ordr-ul-order_li} "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] {#order_csm-GET__ordr-code-order_li} |
| order_line_items | 주문의 각 주문 라인 항목을 정의하는 객체 목록입니다. 주문 라인 항목 \[sn_csm_om_order_line_item\] 테이블에 있습니다. 데이터 유형: 배열 "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] |
| order_line_items.계정 | B2B 주문에 필요합니다. 이 주문 라인 항목에 할당된 비즈니스 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 소비자 속성은 B2C 주문에 필요합니다. 데이터 유형: 문자열 |
| order_line_items.계정 | 이 주문 라인 항목에 할당된 비즈니스 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 데이터 유형: 문자열 |
| order_line_items.작업 | 주문에 주문 라인을 추가하는 방법을 결정하는 작업입니다. 가능한 값: * add * 변경 {#order_csm-GET__ul_sqs_t5h_ctb} 데이터 유형: 문자열 |
| order_line_items.comments | 주문 라인 항목에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| order_line_items.소비자 | 이 주문 라인 항목에 할당된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. 데이터 유형: 문자열 |
| order_line_items.연락처 | 계정과 관련된 접촉 창구 sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.delivered_quantity | 배송된 주문의 항목 수입니다. 데이터 유형: 문자열 |
| order_line_items.유효_날짜 | 주문 라인의 발효 날짜입니다. 형식: yyyy-MM-dd HH:mm:ss(UTC 표준 시간대) 데이터 유형: 문자열 |
| order_line_items.만료_날짜 | 주문 라인의 만료 날짜입니다. 형식: yyyy-MM-dd HH:mm:ss(UTC 표준 시간대) 데이터 유형: 문자열 |
| order_line_items.external_id입니다. | 주문 라인 항목의 외부 ID입니다. 데이터 유형: 문자열 |
| order_line_items.external_system | 주문 라인 항목의 외부 sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.list_price | 단위당 제품 오퍼링의 목록 가격입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.위치 | 위치\[cmn_location\] 테이블에 나열된 배송 위치의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.주문 | 주문\[sn_csm_om_order\] 테이블에 나열된 이 라인 항목의 주문 번호입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics | 연결된 주문 라인 특성을 정의하는 객체 목록입니다. 주문 라인 특성은 주문 라인 특성\[sn_csm_om_order_characteristic_value\] 테이블에 있습니다. "order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ] 데이터 유형: 배열 |
| order_line_items.order_line_characteristics.characteristic_option | 제품 특성: 제외 규칙을 트리거하는 고유한 옵션입니다. 예를 들어, 제품 크기 또는 색상입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. characteristic_option_value | 특성 옵션의 값입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. external_id | 주문 라인 특성의 외부 ID입니다. 데이터 유형: 객체 |
| order_line_items. order_line_characteristics. 수 | 주문 라인 특성\[sn_csm_om_order_characteristic_value\] 테이블에 나열된 주문 라인 특성 번호입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. order_line_item | 주문 라인 항목 \[sn_csm_om_order_line_item\] 테이블에 있는 이 특성의 주문 라인 항목 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. previous_characteristic_option_value | 주문 라인의 제품 모델과 연결된 이전 특성 옵션의 이름입니다. 데이터 유형: 객체 |
| order_line_items. order_line_characteristics.사양 | 서비스 주문 특성과 연결된 서비스 사양입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_class_name | 이 주문 라인 특성 기록이 위치한 테이블의 시스템 이름입니다. 데이터 유형: 문자열 |
| order_line_characteristics. sys_created_by | 이 기록을 생성한 사용자의 시스템 이름입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_created_on | 기록이 처음 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_domain | 주문 기록에 접근할 수 있는 도메인 범위입니다. 예: global. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_domain_path | 기록의 도메인 경로입니다. 데이터 유형: 문자열 기본값: /(전역) |
| order_line_items. order_line_characteristics. sys_id | 주문 라인 특성\[sn_csm_om_order_characteristic_value\] 테이블에 있는 주문 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_mod_count | 이 기록이 수정된 횟수입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_tags | 콘텐츠에 대한 시스템 태그입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_updated_by | 이 기록을 가장 최근에 업데이트한 사용자의 시스템 이름입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics. sys_updated_on | 기록이 가장 최근에 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| order_line_items. order_line_characteristics.type | 주문 라인 특성의 유형입니다. 가능한 값: * 제품 * 서비스 {#order_csm-GET__ul_j3l_4qg_ctb} 데이터 유형: 문자열 |
| order_line_items.order_line_id | 이 주문 라인 항목과 연결된 주문의 주문 번호입니다. 데이터 유형: 문자열 |
| order_line_items.parent_line_item입니다. | 해당하는 경우 이 라인 항목의 상위 라인 항목을 식별합니다. 데이터 유형: 문자열 |
| order_line_items.이전_제품_모델 | 주문 라인에서 이 항목 이전에 나열된 제품의 제품 모델을 식별합니다. 제품 모델 \[cmdb_model\] 테이블에 나열된 제품의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.price_list | 가격 목록 \[sn_csm_pricing_price_list\] 테이블의 가격 목록 기록 Sys_id입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.제품 | 제품 모델 \[cmdb_model\] 테이블에 나열된 제품의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.product_offering | 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 나열된 제품의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.제품 | 제품 모델 \[cmdb_model\] 테이블에 나열된 제품 모델의 Sys_id입니다. 일치하는 주문 라인 항목과 함께 제공되어야 합니다. 데이터 유형: 문자열 |
| order_line_items.product_specification | 주문 라인 항목과 연결된 제품 사양의 Sys_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 표에 나열되어 있습니다. 데이터 유형: 문자열 |
| order_line_items.수량 | 주문한 제품 모델의 수입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_city\[배송_도시\] | 대상 도시의 이름입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_country | 대상 국가의 약어입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_state | 대상 주 또는 도의 약어입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_street | 목적지 주소입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_zip | 목적지 우편 번호입니다. 데이터 유형: 문자열 |
| order_line_items.short_description | 주문 라인 항목에 대한 짧은 설명입니다. 데이터 유형: 문자열 |
| order_line_items.sku | 해당 공급자가 판매한 제품을 고유하게 식별하는 공급자가 생성한 번호입니다. 데이터 유형: 문자열 |
| order_line_items.판매된_제품 | 판매된 제품 \[sn_install_base_sold_product\] 테이블에 나열된 설치 기반 판매된 제품의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.사양 | 주문 라인 항목의 사양입니다. 데이터 유형: 문자열 |
| order_line_items.상태 | 주문 라인의 상태입니다. 예를 들어 초안, 신규, in_progress 또는 완료됨입니다. 데이터 유형: 문자열 |
| order_line_items.status | 주문 라인 항목의 상태입니다. 가능한 값: * 성공 * 실패 {#order_csm-GET__ul_qkt_w2m_ctb} 데이터 유형: 문자열 |
| order_line_items.sys_클래스_이름 | 이 주문 라인 항목 기록이 있는 테이블의 시스템 이름입니다. 데이터 유형: 문자열 |
| order_line_items.sys_created_by 님 | 이 기록을 생성한 사용자의 시스템 이름입니다. 데이터 유형: 문자열 |
| order_line_items.sys_created_on | 기록이 처음 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| order_line_items.sys_도메인 | 주문 기록에 접근할 수 있는 도메인 범위입니다. 예: global. 데이터 유형: 문자열 |
| order_line_items.sys_도메인_경로 | 기록의 도메인 경로입니다. 데이터 유형: 문자열 기본값: /(전역) |
| order_line_items.sys_id | 주문 라인 항목 \[sn_csm_om_order_line_item\] 테이블에 있는 라인 항목 기록의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.sys_mod_count | 이 기록이 수정된 횟수입니다. 데이터 유형: 문자열 |
| order_line_items.sys_tags | 콘텐츠에 대한 시스템 태그입니다. 데이터 유형: 문자열 |
| order_line_items.sys_업데이트_기준 | 이 기록을 가장 최근에 업데이트한 사용자의 시스템 이름입니다. 데이터 유형: 문자열 |
| order_line_items.sys_updated_on | 기록이 가장 최근에 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| order_line_items.top_line_item입니다. | 이 주문에 누적된 모든 주문 라인 항목의 총 가격입니다. 데이터 유형: 문자열 |
| order_line_items.total_price | 주문 라인의 총 가격입니다. API는 순 가격과 수량을 기준으로 총계를 계산하지 않습니다. 데이터 유형: 문자열 |
| order_line_items.측정 단위_중 | 측정 단위 \[sn_prd_pm_uom\] 테이블에 나열된 정렬된 측정 단위에 대한 Sys_id입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.unit_of_measurement | 필수 측정 단위 \[sn_prd_pm_uom\] 테이블에 나열된 정렬된 측정 단위에 대한 Sys_id입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.unit_price | 통화 인스턴스 \[fx_currency_instance\] 테이블에 나열된 단위당 제품 오퍼링의 순 가격입니다. 데이터 유형: 문자열 |
| order_line_items.work_notes | 주문 라인 항목에 대한 자유 형식의 내부 작업 메모입니다. 데이터 유형: 문자열 |
| order_type | 주문이 추가되는 방식을 결정하는 주문 작업입니다. 가능한 값: * add * 변경 데이터 유형: 문자열 |
| 파트너 | B2B 주문의 경우 계정 \[customer_account\] 테이블에 나열된 계정에 대한 연결된 파트너의 sys_id입니다. 데이터 유형: 문자열 |
| partner_contact | B2B 주문의 경우 파트너 계정에 대한 파트너의 기본 접촉 창구 sys_id입니다. 접촉 창구 \[customer_contact\] 테이블에 나열됩니다. 데이터 유형: 문자열 |
| payment_ref_id | 지불의 고유 식별자입니다. 예를 들어, 수표 번호입니다. 데이터 유형: 문자열 |
| price_list | 가격 목록 \[sn_csm_pricing_price_list\] 테이블에 나열된 관련 가격 목록의 Sys_id입니다. 가격은 이 API의 순 가격과 수량을 기준으로 계산되지 않습니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| quote_id | 주문 가격 견적의 고유 ID입니다. 데이터 유형: 문자열 |
| same_as_shipping_address | 구매자의 주소가 배송 주소와 동일한지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 구매자의 주소가 배송 주소와 동일합니다. * false: 구매자의 주소가 배송 주소와 다릅니다. {#order_csm-GET__ul_ygx_zsq_btb} 데이터 유형: 부울 |
| shipping_city | 대상 도시의 이름입니다. 데이터 유형: 문자열 |
| shipping_country | 대상 국가의 약어입니다. 데이터 유형: 문자열 |
| shipping_location | 위치\[cmn_location\] 테이블에 나열된 배송 위치의 Sys_id입니다. 데이터 유형: 문자열 |
| shipping_state | 대상 주 또는 도의 약어입니다. 데이터 유형: 문자열 |
| shipping_street | 목적지 주소입니다. 데이터 유형: 문자열 |
| shipping_zip | 목적지 우편 번호입니다. 데이터 유형: 문자열 |
| short_description | 주문에 대한 짧은 설명입니다. 데이터 유형: 문자열 |
| special_instructions | 주문에 대한 특별 지침입니다. 데이터 유형: 문자열 |
| 상태 | 주문의 상태입니다. 예를 들어 신규, in_progress 또는 완료됨입니다. 데이터 유형: 문자열 |
| 상태 | 주문의 상태입니다. 가능한 값: * 성공 * 실패 {#order_csm-GET__ul_vmw_prm_ctb} 데이터 유형: 문자열 |
| sys_class_name | 이 주문 기록이 있는 테이블의 시스템 이름입니다. 데이터 유형: 문자열 |
| sys_created_by | 이 기록을 생성한 사용자의 시스템 이름입니다. 데이터 유형: 문자열 |
| sys_created_on | 기록이 처음 생성된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| sys_domain | 주문 기록에 접근할 수 있는 도메인 범위입니다. 예: global. 데이터 유형: 문자열 |
| sys_domain_path | 기록의 도메인 경로입니다. 데이터 유형: 문자열 기본값: /(전역) |
| sys_id | 주문 \[sn_csm_om_order\] 테이블에 나열된 주문의 Sys_id입니다. 데이터 유형: 문자열 |
| sys_mod_count | 이 기록이 수정된 횟수입니다. 데이터 유형: 문자열 |
| sys_tags | 콘텐츠에 대한 시스템 태그입니다. 데이터 유형: 문자열 |
| sys_updated_by | 이 기록을 가장 최근에 업데이트한 사용자의 시스템 이름입니다. 데이터 유형: 문자열 |
| sys_updated_on | 기록이 가장 최근에 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| total_amount | 전체 주문의 총 비용입니다. 데이터 유형: 문자열 |
[ ]
### cURL 요청
다음 예제에서는 순서 번호로 주문을 가져오는 방법을 보여 줍니다.
curl "https://instance.service-now.com/api/sn_csm_order_mgmt/order/ORD0001034" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
응답:
{
"result": {
"actual_start_date": "",
"payment_ref_id": null,
"shipping_city": null,
"channel": "api",
"expected_end_date": "",
"sys_updated_on": "2022-03-30 21:59:41",
"price_list": null,
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"contact": "96d0461553ab70101aaeddeeff7b120b",
"sys_domain": "global",
"state": "draft",
"order_type": "add",
"sys_created_by": "eseruser",
"shipping_street": null,
"special_instructions": null,
"contract": null,
"quote_id": null,
"expected_start_date": "",
"sys_domain_path": "/",
"billing_street": null,
"billing_city": null,
"total_amount": "2000",
"order_id": "ORD0001034",
"shipping_country": "USA",
"status": "new",
"short_description": null,
"shipping_state": null,
"external_id": null,
"sys_class_name": "sn_csm_om_order",
"sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
"shipping_zip": null,
"billing_state": null,
"billing_zip": null,
"same_as_shipping_address": "0",
"consumer": null,
"comments": "",
"order_currency": "USD",
"billing_country": "USA",
"sys_mod_count": "1",
"billing_location": null,
"shipping_location": null,
"sys_tags": "",
"order_date": "2022-03-30 21:59:41",
"order_category": "product",
"actual_end_date": "",
"partner": null,
"partner_contact": null,
"account": "c480021553ab70101aaeddeeff7b120f",
"external_system": null,
"order_line_items": [
{
"short_description": null,
"shipping_state": "CA",
"shipping_city": "Santa Clara",
"product_offering": "2d4376760f740110603bf634a7767e46",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"expiration_date": "",
"sys_class_name": "sn_csm_om_order_line_item",
"sold_product": null,
"sys_id": "ecfdf5bd75eec510f877f30c01a15aa3",
"unit_of_measurement": "cb2795d553020110286eddeeff7b12ff",
"price_list": null,
"sys_updated_by": "username",
"shipping_zip": "94560",
"sys_created_on": "2022-03-30 21:59:41",
"contact": "96d0461553ab70101aaeddeeff7b120b",
"sys_domain": "global",
"effective_date": "",
"action": "add",
"order_line_id": "ORDL0001060",
"state": "draft",
"sku": null,
"consumer": null,
"sys_created_by": "username",
"order": "24fdf5bd75eec510f877f30c01a15aa0",
"previous_product_model": null,
"shipping_street": "222 Star St",
"product": "561dba7e0f740110603bf634a7767ebe",
"quantity": "1",
"comments": "",
"total_price": "2000",
"parent_line_item": null,
"sys_mod_count": "1",
"specification": "104f66720f740110603bf634a7767e7d",
"list_price": "2000",
"unit_price": "2000",
"sys_domain_path": "/",
"sys_tags": "",
"delivered_quantity": null,
"top_line_item": null,
"product_specification": "104f66720f740110603bf634a7767e7d",
"location": null,
"work_notes": "",
"shipping_country": "USA",
"account": "c480021553ab70101aaeddeeff7b120f",
"external_system": null,
"status": "new",
"order_line_characteristics": [
{
"characteristic_option": "1c6ceabe0f340110603bf634a7767e97",
"sys_mod_count": "0",
"specification": "104f66720f740110603bf634a7767e7d",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"type": "1",
"sys_domain_path": "/",
"sys_tags": "",
"characteristic": "4e76f1b20fb00110603bf634a7767ee3",
"sys_class_name": "sn_csm_om_order_characteristic_value",
"previous_characteristic_option_value": null,
"number": "ORC000001041",
"sys_id": "acfd79bd75eec510f877f30c01a15a94",
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"sys_domain": "global",
"characteristic_option_value": "1.2 cu",
"order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
"sys_created_by": "user"
},
{
"characteristic_option": "2d0d66fe0f340110603bf634a7767ef6",
"sys_mod_count": "0",
"specification": "104f66720f740110603bf634a7767e7d",
"external_id": null,
"sys_updated_on": "2022-03-30 21:59:41",
"type": "1",
"sys_domain_path": "/",
"sys_tags": "",
"characteristic": "11e639b20fb00110603bf634a7767e17",
"sys_class_name": "sn_csm_om_order_characteristic_value",
"previous_characteristic_option_value": null,
"number": "ORC000001042",
"sys_id": "e0fd79bd75eec510f877f30c01a15a95",
"sys_updated_by": "username",
"sys_created_on": "2022-03-30 21:59:41",
"sys_domain": "global",
"characteristic_option_value": "Stainless steel",
"order_line_item": "ecfdf5bd75eec510f877f30c01a15aa3",
"sys_created_by": "user"
}
]
}
]
}
}
## 주문 API -- POST /sn_csm_order_mgmt/order {#ariaid-title3}
라인 항목 및 특성이 있는 새 주문을 생성합니다.
라인 항목이 있는 주문은 요청 본문 매개변수를 사용하여 정의됩니다. 대부분의 버전에는 다음 속성이 필요합니다.주문 관리
* account B2B 주문 또는 consumer B2C 주문의 경우.
* account -- 계정 \[customer_account\] 테이블에 있는 기록의 Sys_id입니다.
* consumer -- 소비자 \[csm_consumer\] 테이블에 있는 기록의 Sys_id입니다.
{#order_csm-POST__ul_h5j_my1_dtb}
* order_currency -- 주문을 구매한 통화를 나타내는 통화 코드입니다. 예를 들어 미국 달러의 경우 USD 입니다. 이 통화는 주문 및 라인 주문의 모든 금액 필드에 사용됩니다. 통화 코드는 통화 \[fx_currency\] 테이블에 나열됩니다.
* order_line_items -- 주문의 각 주문 라인 항목을 정의하는 객체 목록입니다. 주문 라인 항목 \[sn_csm_om_order_line_item\] 테이블에 있습니다. 각 주문 라인 항목 객체의 필수 속성:
* account B2B 주문 또는 consumer B2C 주문의 경우.
* account -- 이 주문 라인 항목에 할당된 비즈니스 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다.
* consumer -- 이 주문 라인 항목에 할당된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다.
{#order_csm-POST__ul_dqm_qbb_dtb}
* order_line_characteristics -- 연결된 주문 라인 특성을 정의하는 객체 목록입니다. 주문 라인 특성은 주문 라인 특성\[sn_csm_om_order_characteristic_value\] 테이블에 있습니다.
* product_offering -- 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 나열된 제품의 Sys_id입니다.
* quantity -- 주문한 제품 모델의 수입니다.
* unit_of_measurements -- 측정 단위 \[sn_prd_pm_uom\] 테이블에 나열된 정렬된 측정 단위에 대한 Sys_id입니다.
요청 본문 매개 변수 테이블에 자세한 내용이 포함되어 있습니다.
### URL 형식
버전이 지정된 URL: /api/sn_csm_order_mgmt/{api_version}/order
기본 URL: /api/sn_csm_order_mgmt/order
### 지원되는 요청 매개변수
{#order_csm-POST__entry__2}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 7. 경로 매개변수]
{#order_csm-POST__entry__6}
| 이름 | 설명 |
|-|-|
| 없음 | |
[표 8. 쿼리 매개변수]
{#order_csm-POST__entry__10}{#order_csm-POST__order_ph_account}{#order_csm-POST__order_ph_consumer}{#order_csm-POST__ordr-ph-order_currency}{#order_csm-POST__ordr-ph-order_li}{#order_csm-POST__ordr-ph-order_li-account}{#order_csm-POST__ordr-ph-order_li-consumer}{#order_csm-POST__ordr-ph-order_li-char}{#order_csm-POST__ordr-ph-order_li-product}{#order_csm-POST__ordr-ph-order_li-product_offering}{#order_csm-POST__ordr-row-order_li-product_spec}{#order_csm-POST__ordr-ph-order_li-quantity}{#order_csm-POST__ordr-ph-unit_of_meas}
| 이름 | 설명 |
|-|-|
| 계정 | B2B 주문에 필요합니다. 계정 \[customer_account\] 테이블에 있는 기록의 Sys_id입니다. 소비자 속성은 B2C 주문에 필요합니다. 데이터 유형: 문자열 |
| actual_end_date | 주문의 종료 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| actual_start_date | 주문 시작 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| billing_city | 청구 도시의 이름입니다. 데이터 유형: 문자열 |
| billing_country | 청구 국가의 약어입니다. 데이터 유형: 문자열 |
| billing_state | 청구 시/도의 약어입니다. 데이터 유형: 문자열 |
| billing_street | 청구지 주소입니다. 데이터 유형: 문자열 |
| billing_zip | 청구 우편 번호입니다. 데이터 유형: 문자열 |
| 설명 | 주문에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| 소비자 | B2C 주문에 필요합니다. 소비자 \[csm_consumer\] 테이블에 있는 기록의 Sys_id입니다. B2B 주문에는 계정 속성이 필요합니다. 데이터 유형: 문자열 |
| 연락처 | 계정과 관련된 고객 접촉 창구의 Sys_id입니다. 접촉 창구 \[customer_contact\] 테이블에 나열됩니다. 데이터 유형: 문자열 |
| 계약 | 계약 \[ast_contract\] 테이블에 나열된 계약의 고객 서비스 Sys_id입니다. 데이터 유형: 문자열 |
| expected_end_date | 주문의 예상 종료 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| expected_start_date | 주문의 예상 시작 날짜입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| external_id | 외부 공급업체 시스템의 관련 기록을 나타내는 외부 ID입니다. 데이터 유형: 문자열 |
| external_system | 고객 시스템의 이름입니다. 데이터 유형: 문자열 |
| order_category | 고객 주문 유형입니다. 가능한 값: * 제품 * 서비스 {#order_csm-POST__ul_j3l_4qg_ctb} 데이터 유형: 문자열 |
| order_currency | 필수 주문을 구매한 통화를 나타내는 통화 코드입니다. 예를 들어 미국 달러의 경우 USD 입니다. 이 통화는 주문 및 라인 주문의 모든 금액 필드에 사용됩니다. 통화 코드는 통화 \[fx_currency\] 테이블에 나열됩니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_date | 주문이 생성된 날짜 및 시간입니다. 형식: UTC 형식, yyyy-MM-dd HH:mm:ss 데이터 유형: 문자열 |
| order_line_items | 필수 주문의 각 주문 라인 항목을 정의하는 객체 목록입니다. 주문 라인 항목 \[sn_csm_om_order_line_item\] 테이블에 있습니다. 데이터 유형: 배열 각 주문 라인 항목 객체의 필수 속성: * account B2B 주문 또는 consumer B2C 주문의 경우.{#order_csm-POST__ordr-ph-order_li-acct-cons} * product_offering -- * quantity * unit_of_measurements * order_line_characteristics {#order_csm-POST__ordr-ul-order_li} "order_line_items": [ { "account": "String", "action": "String", "comments": "String", "consumer": "String", "contact": "String", "delivered_quantity": "String", "effective_date": "String", "expiration_date": "String", "external_id": "String", "external_system": "String", "list_price": "String", "location": "String", "order_line_characteristics": [Array], "order_line_id": "String", "order": "String", "parent_line_item": "String", "previous_product_model": "String", "price_list": "String", "product_offering": "String", "product_specification": "String", "product": "String", "quantity": "String", "shipping_city": "String", "shipping_country": "String", "shipping_state": "String", "shipping_street": "String", "shipping_zip": "String", "short_description": "String", "sku": "String", "sold_product": "String", "specification": "String", "state": "String", "status": "String", "sys_class_name": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_mod_count": "String", "sys_tags": "String", "sys_updated_by": "String", "sys_updated_on": "String", "top_line_item": "String", "total_price": "String", "unit_of_measurement": "String", "unit_price": "String", "work_notes": "String" } ] {#order_csm-POST__ordr-code-order_li} |
| order_line_items.계정 | B2B 주문에 필요합니다. 이 주문 라인 항목에 할당된 비즈니스 계정의 Sys_id입니다. 계정 \[customer_account\] 테이블에 있습니다. 소비자 속성은 B2C 주문에 필요합니다. 데이터 유형: 문자열 |
| order_line_items.작업 | 주문에 주문 라인을 추가하는 방법을 결정하는 작업입니다. 가능한 값: * add * 변경 {#order_csm-POST__ul_sqs_t5h_ctb} 데이터 유형: 문자열 |
| order_line_items.comments | 주문 라인 항목에 대한 추가 정보입니다. 데이터 유형: 문자열 |
| order_line_items.소비자 | B2C 주문에 필요합니다. 이 주문 라인 항목에 할당된 소비자의 Sys_id입니다. 소비자 \[csm_consumer\] 테이블에 있습니다. B2B 주문에는 계정 속성이 필요합니다. 데이터 유형: 문자열 |
| order_line_items.연락처 | 계정과 관련된 접촉 창구 sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.delivered_quantity | 배송된 주문의 항목 수입니다. 데이터 유형: 문자열 |
| order_line_items.유효_날짜 | 주문 라인의 발효 날짜입니다. 형식: yyyy-MM-dd HH:mm:ss(UTC 표준 시간대) 데이터 유형: 문자열 |
| order_line_items.만료_날짜 | 주문 라인의 만료 날짜입니다. 형식: yyyy-MM-dd HH:mm:ss(UTC 표준 시간대) 데이터 유형: 문자열 |
| order_line_items.external_id입니다. | 주문 라인 항목의 외부 ID입니다. 데이터 유형: 문자열 |
| order_line_items.external_system | 주문 라인 항목의 외부 sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.list_price | 단위당 제품 오퍼링의 목록 가격입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.order_line_characteristics | 필수 연결된 주문 라인 특성을 정의하는 객체 목록입니다. 주문 라인 특성은 주문 라인 특성\[sn_csm_om_order_characteristic_value\] 테이블에 있습니다. 최신 릴리스에서 오퍼링이 제품 사양과 연결된 경우 제품 모델을 결정하기 위해 주문 특성을 포함해야 합니다. 이전 릴리스에서 이 속성은 속성이 설정된 단순 주문 order_line_items.product_specification 에만 필요했습니다. 데이터 유형: 배열 "order_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String" } ] {#order_csm-POST__ordr-code-order_li-char} |
| order_line_items.order_line_characteristics.특성 | 제품 모델과 연결된 특성의 이름입니다. 예를 들어, 식기세척기 크기입니다. 데이터 유형: 문자열 |
| order_line_items.order_line_characteristics.characteristic_option | 제품 특성: 제외 규칙을 트리거하는 고유한 옵션입니다. 예를 들어, 제품 크기 또는 색상입니다. 데이터 유형: 문자열 |
| order_line_items.price_list | 가격 목록 \[sn_csm_pricing_price_list\] 테이블의 가격 목록 기록 Sys_id입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.제품 | 제품 모델 \[cmdb_model\] 테이블에 나열된 제품 모델의 Sys_id입니다. 요청 본문에 포함된 경우 연결된 주문 라인 특성이 일치해야 합니다. 데이터 유형: 문자열 |
| order_line_items.product_offering | 필수 제품 오퍼링 \[sn_prd_pm_product_offering\] 테이블에 나열된 제품의 Sys_id입니다. 오퍼링이 제품 모델과 연결된 경우 제품 모델은 주문에 따라 결정됩니다. 오퍼링이 제품 사양과 연결된 경우 제품 모델을 결정하기 위해 주문 특성을 포함해야 합니다. 데이터 유형: 문자열 |
| order_line_items.product_specification | 필수 주문 라인 항목과 연결된 제품 사양의 Sys_id입니다. 제품 사양 \[sn_prd_pm_product_specification\] 표에 나열되어 있습니다. 주: 이 속성은 이전 버전의 주문 관리에서 필요하지 않았습니다. 데이터 유형: 문자열 |
| order_line_items.수량 | 필수 주문한 제품 모델의 수입니다. 주: 이 속성은 이전 버전의 주문 관리. 데이터 유형: 문자열 |
| order_line_items.shipping_city\[배송_도시\] | 대상 도시의 이름입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_country | 대상 국가의 약어입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_state | 대상 주 또는 도의 약어입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_street | 목적지 주소입니다. 데이터 유형: 문자열 |
| order_line_items.shipping_zip | 목적지 우편 번호입니다. 데이터 유형: 문자열 |
| order_line_items.short_description | 주문 라인 항목에 대한 짧은 설명입니다. 데이터 유형: 문자열 |
| order_line_items.sku | 해당 공급자가 판매한 제품을 고유하게 식별하는 공급자가 생성한 번호입니다. 데이터 유형: 문자열 |
| order_line_items.판매된_제품 | 판매된 제품 \[sn_install_base_sold_product\] 테이블에 나열된 설치 기반 판매된 제품의 Sys_id입니다. 데이터 유형: 문자열 |
| order_line_items.사양 | 주문 라인 항목의 사양입니다. 데이터 유형: 문자열 |
| order_line_items.상태 | 주문 라인의 상태입니다. 예를 들어 초안, 신규, in_progress 또는 완료됨입니다. 데이터 유형: 문자열 |
| order_line_items.total_price | 주문 라인의 총 가격입니다. 총 가격은 이 API의 순 가격과 수량을 기준으로 계산되지 않습니다. 데이터 유형: 문자열 |
| order_line_items.unit_of_measurement | 필수 측정 단위 \[sn_prd_pm_uom\] 테이블에 나열된 정렬된 측정 단위에 대한 Sys_id입니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| order_line_items.unit_price | 통화 인스턴스 \[fx_currency_instance\] 테이블에 나열된 단위당 제품 오퍼링의 순 가격입니다. 데이터 유형: 문자열 |
| order_line_items.work_notes | 주문 라인 항목에 대한 자유 형식의 내부 작업 메모입니다. 데이터 유형: 문자열 |
| order_type | 주문이 추가되는 방식을 결정하는 주문 작업입니다. 가능한 값: * add * 변경 데이터 유형: 문자열 |
| 파트너 | B2B 주문의 경우 계정 \[customer_account\] 테이블에 나열된 계정에 대한 연결된 파트너의 sys_id입니다. 데이터 유형: 문자열 |
| partner_contact | B2B 주문의 경우 파트너 계정에 대한 파트너의 기본 접촉 창구 sys_id입니다. 접촉 창구 \[customer_contact\] 테이블에 나열됩니다. 데이터 유형: 문자열 |
| price_list | 가격 목록 \[sn_csm_pricing_price_list\] 테이블에 나열된 관련 가격 목록의 Sys_id입니다. 가격은 이 API의 순 가격과 수량을 기준으로 계산되지 않습니다. 주: 이 속성은 이전 버전의 주문 관리에서 사용하지 못할 수 있습니다. 데이터 유형: 문자열 |
| quote_id | 주문 가격 견적의 고유 ID입니다. 데이터 유형: 문자열 |
| shipping_city | 대상 도시의 이름입니다. 데이터 유형: 문자열 |
| shipping_country | 대상 국가의 약어입니다. 데이터 유형: 문자열 |
| shipping_state | 대상 주 또는 도의 약어입니다. 데이터 유형: 문자열 |
| shipping_street | 목적지 주소입니다. 데이터 유형: 문자열 |
| shipping_zip | 목적지 우편 번호입니다. 데이터 유형: 문자열 |
| short_description | 주문에 대한 짧은 설명입니다. 데이터 유형: 문자열 |
| special_instructions | 주문에 대한 특별 지침입니다. 데이터 유형: 문자열 |
| 상태 | 주문의 상태입니다. 예를 들어 신규, in_progress 또는 완료됨입니다. 데이터 유형: 문자열 |
| total_amount | 전체 주문의 총 비용입니다. 데이터 유형: 문자열 |
[표 9. 요청 본문 매개변수(XML 또는 JSON)]
### 헤더
다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#order_csm-POST__entry__146}{#order_csm-POST__accept-RESTAPI}
| 헤더 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json |
[표 10. 요청 헤더]
{#order_csm-POST__entry__150}
| 헤더 | 설명 |
|-|-|
| 없음 | |
[표 11. 응답 헤더]
### 상태 코드
다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 [REST API HTTP 응답 코드를](https://servicenow-prod.fluidtopics.net/JHL64oGR2SkU25ZTkfHy7g "REST(REpresentational State Transfer)는 웹상의 컴퓨터 시스템 간에 표준을 제공하여 서로 보다 쉽게 통신할 수 있게 지원하는 단순한 상태 비저장 아키텍처입니다.") 참조하세요.
{#order_csm-POST__entry__154}{#order_csm-POST__entry-200-status-code}
| 상태 코드 | 설명 |
|-|-|
| 200 | 성공입니다. 요청이 성공적으로 처리되었습니다. |
| 400 | 잘못된 요청입니다. 페이로드가 예상 형식이 아닙니다. |
| 401 | 사용자가 인증되지 않았습니다. |
| 403 | 사용자에게 권한이 없습니다. * 사용자에게 API에 액세스하는 데 필요한 역할이 없습니다. * 사용자에게 주문을 읽을 수 있는 권한이 없습니다. {#order_csm-POST__ul_ktg_jfp_1tb} 이 API에 액세스하려면 sn_csm_om.order_integrator가 필요하며 다음 중 하나가 필요합니다. * sn_csm_om.consumer_agent -- API 쓰기 액세스는 B2C 주문으로 제한됩니다. * sn_csm_om.customer_agent -- API 쓰기 액세스는 B2B 주문으로 제한됩니다. * sn_csm_om.order_admin -- B2B 또는 B2C 주문에 대한 API 쓰기 액세스 권한입니다. {#order_csm-POST__ul_gfd_tfn_ctb} |
| 500 | 내부 서버 오류입니다. 하나 이상의 확인에 실패했습니다. 가능한 문제: * Account 또는 consumer 매개변수가 누락되었습니다. 이러한 필드는 헤더와 항목에서 필수입니다. * Account/contact 및 consumer 매개변수가 전달되었습니다. 이러한 매개변수는 함께 전달할 수 없습니다. * 선택 매개변수: 잘못된 선택 값이 전달되었습니다. * 수량 매개변수: 잘못된 값입니다. * 잘못된 참조 필드입니다. * 누락된 필수 필드. * 잘못된 날짜 및 시간 형식입니다. * 시작 날짜가 종료 날짜보다 이후입니다. * 잘못된 특성입니다. * 잘못된 특성 옵션입니다. * 제공된 특성에 대해 두 개 이상의 제품 모델이 발견되었습니다. * 제공된 특성에 대한 제품 모델을 찾을 수 없습니다. * 사용자에게 주문을 생성할 수 있는 액세스 권한이 없습니다. * B2B 주문에는 소비자 주문 라인이 포함되어 있습니다. * B2C 주문에는 거래처, 접촉 창구, 파트너 또는 파트너 접촉 창구 매개변수가 포함되어 있습니다. * 금액 필드 통화가 주문 통화와 일치하지 않습니다. * Order_line_characteristics 제품 모델과 연결된 주문 라인 product_offering 에 대해 전달되었습니다. * 제안 유형=구성에 지정된 측정 단위가 제품 오퍼링에 정의된 허용된 측정 단위에 속하지 않습니다. * 제품 오퍼링에 구성이 예상될 때 오퍼 유형의 구성에 대한 특성이 전달되지 않았습니다. * 주문 라인에 번들 항목과 단순 구성이 있는 주문은 생성할 수 없습니다. * 전달된 매개변수에는 번들 오퍼링에 대한 특성이 포함되어 있습니다. * 상위 주문 라인 및/또는 하위 주문 라인을 생성할 수 없습니다. 번들 오퍼링 호출에서는 상위 번들 항목만 유효합니다. * 번들 오퍼링에 대해 지정된 unit_of_measurement 기록에 "EACH" 이외의 값이 포함되어 있습니다. |
[표 12. 상태 코드]
### 응답 본문 매개변수(JSON 또는 XML)
{#order_csm-POST__entry__166}
| 이름 | 설명 |
|-|-|
| 오류 | 요청 프로세스 중에 발생한 오류를 설명하는 상세 정보입니다. 데이터 유형: 객체 "error": { "detail": "String", "message": "String" } |
| 오류.상세 정보 | 요청 프로세스 중에 발생한 오류에 대한 상세 정보입니다. 데이터 유형: 문자열 |
| 오류.메시지 | 요청 프로세스 중에 발생한 오류에 대한 메시지입니다. 각 오류 메시지에는 속성에 해당 설명이 detail 있습니다. 데이터 유형: 문자열 |
| order_id | 주문 \[sn_csm_om_order\] 테이블에 나열된 주문의 주문 번호입니다. 데이터 유형: 문자열 |
| 상태 | 오류 객체 외에 포함된 실패 메시지입니다. 데이터 유형: 문자열 |
| sys_id | 주문 \[sn_csm_om_order\] 테이블에 나열된 주문의 Sys_id입니다. 데이터 유형: 문자열 |
[ ]
### cURL 요청
다음 예제에서는 스테인리스 스틸 전자레인지에 대한 단일 품목 주문을 만드는 방법을 보여 줍니다.
curl "https://instance.service-now.com/api/sn_csm_order_mgmt/order" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"contact\":\"96d0461553ab70101aaeddeeff7b120b\",
\"order_currency\": \"USD\",
\"order_line_items\": [
{
\"account\": \"c480021553ab70101aaeddeeff7b120f\",
\"action\": \"add\",
\"contact\": \"96d0461553ab70101aaeddeeff7b120b\",
\"list_price\": \"2000\",
\"order_line_characteristics\": [
{
\"characteristic\" : \"Solana color\",
\"characteristic_option\" : \"Stainless steel\"
},
{
\"characteristic\" :\"Microvawe Capacity\",
\"characteristic_option\" : \"1.2 cu\"
}
],
\"product_offering\": \"2d4376760f740110603bf634a7767e46\",
\"quantity\": \"1\",
\"shipping_city\": \"Santa Clara\",
\"shipping_country\": \"USA\",
\"shipping_state\": \"CA\",
\"shipping_street\": \"222 Star St\",
\"shipping_zip\": \"94560\",
\"state\": \"draft\",
\"status\": \"new\",
\"total_price\": \"2000\",
\"unit_of_measurement\": \"cb2795d553020110286eddeeff7b12ff\",
\"unit_price\": \"2000\"
}
]
}" \
--user 'user':'password'
응답:
{
"result": {
"sys_id": "24fdf5bd75eec510f877f30c01a15aa0",
"order_id": "ORD0001034"
}
}