ทรัพยากรสินค้าคงคลัง
หมายเหตุ
API สินค้าคงคลังพร้อมใช้งานสําหรับผู้เข้าร่วมนําร่องที่ปิดเท่านั้น API และเอกสารอาจเปลี่ยนแปลงได้
ทรัพยากรสินค้าคงคลังช่วยให้คุณสามารถอัปเดตราคาและความพร้อมใช้งานของผลิตภัณฑ์ในร้านค้า Microsoft Merchant Center (MMC) ของคุณได้ สําหรับข้อมูลเกี่ยวกับการใช้ทรัพยากรสินค้าคงคลัง ให้ดู การอัปเดตการกําหนดราคาผลิตภัณฑ์ ตัวอย่างเช่น ที่แสดงวิธีอัปเดตราคาและความพร้อมใช้งาน โปรดดู ตัวอย่างโค้ด
URI พื้นฐาน
ต่อไปนี้คือ URI พื้นฐานที่คุณผนวกเทมเพลต
https://content.api.bingads.microsoft.com/shopping/v9.1
เทมเพลต
หากต้องการสร้างจุดสิ้นสุดที่ใช้ในการอัปเดตข้อเสนอผลิตภัณฑ์ของคุณ ให้ผนวกเทมเพลตที่เหมาะสมเข้ากับ URI พื้นฐาน
แม่ แบบ | คํากริยา HTTP | คำอธิบาย |
---|---|---|
/bmc/{mmcMerchantId}/inventory/batch | ประกาศ | ใช้เพื่ออัปเดตการกําหนดราคาผลิตภัณฑ์หลายรายการในคําขอเดียว ตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMCวัตถุคําขอ: ชุดงาน วัตถุตอบสนอง: ชุดงาน |
/bmc/{mmcMerchantId}/inventory/{storeCode}/products/{productUniqueId} | ประกาศ | ใช้ เพื่ออัปเดตการกําหนดราคาและความพร้อมใช้งานของผลิตภัณฑ์เดียว ตั้งค่า {mmcMerchantId} เป็น ID ที่เก็บ MMCตั้งค่า {storeCode} เป็นออนไลน์ตั้งค่า {productUniqueId} เป็นรหัสผลิตภัณฑ์ที่มีคุณสมบัติครบถ้วน (ตัวอย่างเช่น Online:en:US:Sku123)ร้องขอวัตถุ: ผลิตภัณฑ์ วัตถุการตอบกลับ: ผลิตภัณฑ์ |
พารามิเตอร์คิวรี
ปลายทางอาจรวมถึงพารามิเตอร์คิวรีต่อไปนี้
พารามิเตอร์ | คำอธิบาย |
---|---|
แห้ง- ทํางาน | เสริม ใช้เมื่อดีบักแอปพลิเคชันของคุณเพื่อทดสอบการโทร การเรียกที่รวมพารามิเตอร์นี้จะไม่ส่งผลกระทบต่อข้อมูลการผลิต ถ้ามีข้อผิดพลาดเกิดขึ้น การตอบกลับจะมีข้อผิดพลาดใดๆ ที่การโทรสร้างขึ้นตามปกติ ยกเว้นข้อความแสดงข้อผิดพลาดรอง เช่น คุณภาพข้อมูล ปัญหาด้านบรรณาธิการ และการตรวจสอบที่เกี่ยวข้องกับฐานข้อมูล สําหรับข้อมูลเพิ่มเติมเกี่ยวกับการทดสอบแอปพลิเคชันของคุณ ให้ดู Sandbox |
หัว กระดาษ
ต่อไปนี้คือส่วนหัวของคําขอและการตอบสนอง
หัว ข้อ | คำอธิบาย |
---|---|
AuthenticationToken | ส่วนหัวของคําขอ ตั้งค่าส่วนหัวนี้เป็นโทเค็นการเข้าถึง OAuth สําหรับข้อมูลเกี่ยวกับการรับโทเค็นการเข้าถึง ให้ดู การรับรองความถูกต้องข้อมูลประจําตัวของคุณ |
Content-Type | ส่วนหัวคําขอและการตอบสนอง ชนิดของเนื้อหาในเนื้อความของการร้องขอหรือการตอบสนอง ตั้งค่าเป็นแอปพลิเคชัน/json |
CustomerAccountId | ส่วนหัวของคําขอ ID บัญชีของบัญชีใดๆ ที่คุณจัดการในนามของลูกค้าที่ระบุไว้ใน CustomerId ส่วนหัว ไม่สําคัญว่าคุณระบุบัญชีใด ระบุหัวข้อนี้เฉพาะเมื่อคุณจัดการบัญชีในนามของลูกค้าเท่านั้น |
CustomerId | ส่วนหัวของคําขอ รหัสลูกค้าของลูกค้าที่คุณจัดการร้านค้า ระบุหัวข้อนี้เฉพาะเมื่อคุณจัดการร้านค้าในนามของลูกค้าเท่านั้น หากคุณตั้งค่าส่วนหัวนี้ คุณต้องตั้งค่า CustomerAccountId ส่วนหัวด้วย |
DeveloperToken | ส่วนหัวของคําขอ โทเค็นนักพัฒนาของแอปพลิเคชันไคลเอ็นต์ แต่ละคําขอต้องมีส่วนหัวนี้ สําหรับข้อมูลเกี่ยวกับการรับโทเค็น ให้ดูที่ คุณมีข้อมูลประจําตัว Microsoft Advertising และโทเค็นสําหรับนักพัฒนาหรือไม่ |
สถาน | ส่วนหัวการตอบสนอง URL ของผลิตภัณฑ์ที่มีการอัปเดต |
WebRequestActivityId | ส่วนหัวการตอบสนอง ID ของรายการแฟ้มบันทึกที่ประกอบด้วยรายละเอียดของการร้องขอ คุณควรจับภาพ ID นี้เสมอถ้ามีข้อผิดพลาดเกิดขึ้น หากคุณไม่สามารถระบุและแก้ไขปัญหาได้ ให้ใส่ ID นี้พร้อมกับข้อมูลอื่น ๆ ที่คุณให้ทีมสนับสนุน |
วัตถุการร้องขอและการตอบสนอง
ต่อไปนี้คือคําขอและวัตถุการตอบสนองที่ใช้โดย API
วัตถุ | คำอธิบาย |
---|---|
ชุด | กําหนดรายการผลิตภัณฑ์ที่จะอัพเดตในคําขอชุดงาน |
ข้อผิดพลาด | กําหนดข้อผิดพลาด |
ErrorResponse | กําหนดออบเจ็กต์ข้อผิดพลาดระดับบนสุดสําหรับการอัพเดตที่ไม่ใช่ชุดงาน |
BatchEntryError | กําหนดข้อผิดพลาดที่เกิดขึ้นสําหรับสินค้าในระหว่างการประมวลผลชุดงาน |
รายการ | กําหนดรายการในคําขอชุดงานหรือการตอบสนอง |
ผลิตภัณฑ์ | กําหนดผลิตภัณฑ์ |
ProductPrice | กําหนดราคาของผลิตภัณฑ์ |
ชุด
กําหนดรายการผลิตภัณฑ์ที่จะอัพเดตในชุดงาน
ชื่อ | ค่า | ชนิด |
---|---|---|
รายการ | รายการผลิตภัณฑ์ที่จะอัพเดตในชุดงาน จํานวนสูงสุดของผลิตภัณฑ์ที่คุณสามารถระบุได้คือ 400 | Entry[] |
BatchEntryError
กําหนดข้อผิดพลาดที่เกิดขึ้นสําหรับรายการในระหว่างการประมวลผลชุดงาน
ชื่อ | ค่า | ชนิด |
---|---|---|
ข้อ ผิด พลาด | รายการข้อผิดพลาดที่เกิดขึ้นขณะประมวลผลรายการ | ข้อผิดพลาด[] |
รหัส | รหัสสถานะของ HTTP ของข้อผิดพลาด | สตริง |
ข้อความ | ข้อความที่เกี่ยวข้องกับข้อผิดพลาด | สตริง |
ข้อผิดพลาด
กําหนดข้อผิดพลาด
ชื่อ | ค่า | ชนิด |
---|---|---|
โด เมน | สําหรับใช้ภายในเท่านั้น | สตริง |
ข้อความ | คําอธิบายของข้อผิดพลาด | สตริง |
เหตุผล | เหตุผลที่คําขอล้มเหลว ตัวอย่างเช่น ผลิตภัณฑ์ล้มเหลวในการตรวจสอบความถูกต้อง | สตริง |
ErrorResponse
กําหนดวัตถุข้อผิดพลาดระดับบนสุดสําหรับการอัปเดตผลิตภัณฑ์เดียว
ชื่อ | ค่า | ชนิด |
---|---|---|
ข้อ ผิด พลาด | รายการข้อผิดพลาดที่เกิดขึ้นขณะประมวลผลรายการ | Errors[] |
ข้อ ผิด พลาด
กําหนดรายการของข้อผิดพลาดสําหรับผลิตภัณฑ์
ชื่อ | ค่า | ชนิด |
---|---|---|
ข้อ ผิด พลาด | รายการข้อผิดพลาดที่เกิดขึ้นขณะประมวลผลรายการ | ข้อผิดพลาด[] |
รหัส | รหัสสถานะของ HTTP ของข้อผิดพลาด | สตริง |
ข้อความ | ข้อความที่เกี่ยวข้องกับข้อผิดพลาด | สตริง |
รายการ
กําหนดรายการในคําขอชุดงาน
ชื่อ | ค่า | ชนิด |
---|---|---|
batchId | ID ที่ผู้ใช้กําหนดเองซึ่งระบุเฉพาะรายการนี้ในคําขอชุดงาน ตัวอย่างเช่น ถ้าชุดงานมีรายการ 10 รายการ คุณสามารถกําหนดได้ ID เป็น 1 ถึง 10 | จํานวนเต็มแบบไม่ใส่เครื่องหมาย |
ข้อ ผิด พลาด | วัตถุข้อผิดพลาดที่ประกอบด้วยรายการข้อผิดพลาดในการตรวจสอบความถูกต้องที่เกิดขึ้น การตอบสนองรวมถึงเขตข้อมูลนี้เฉพาะเมื่อมีข้อผิดพลาดเกิดขึ้นเท่านั้น | BatchEntryError |
สินค้า คง คลัง | ราคาและความพร้อมใช้งานที่อัปเดตแล้ว | ผลิตภัณฑ์ |
merchantId | ID ร้านค้า Merchant Center เนื่องจาก URL มี ID ร้านค้า เขตข้อมูลนี้จึงถูกละเว้น | แบบยาวแบบไม่ใส่ลายเซ็น |
productId | รหัสผลิตภัณฑ์ที่มีคุณสมบัติครบถ้วน (ตัวอย่างเช่น Online:en:US:Sku123) ของผลิตภัณฑ์ที่จะอัปเดต อย่ารวมรายการหลายรายการที่มี ID ผลิตภัณฑ์เดียวกัน | สตริง |
storeCode | รหัสที่ระบุร้านค้าที่จะอัปเดต ตั้งค่า เป็นออนไลน์ เพื่อปรับปรุงราคาและความพร้อมใช้งานของผลิตภัณฑ์ในร้านค้าออนไลน์ | สตริง |
ผลิตภัณฑ์
กําหนดผลิตภัณฑ์
คุณสมบัติ | คำอธิบาย | ชนิด | ต้องระบุ |
---|---|---|---|
ความพร้อมใช้งาน | ความพร้อมใช้งานของผลิตภัณฑ์ ค่าที่เป็นไปได้:
|
สตริง | ใช่ |
ชนิด | ชนิดของวัตถุ ตั้งค่าเป็น content#inventory | สตริง | ไม่ใช่ |
ราคา | ราคาใหม่ของผลิตภัณฑ์ ระบุราคาในสกุลเงินของประเทศหรือภูมิภาคเป้าหมาย สําหรับข้อมูลว่าจะรวมภาษีในราคาหรือไม่ ดูนโยบายภาษีของแค็ตตาล็อก Microsoft Merchant Center ราคาต้องตรงกับราคาที่แสดงบนหน้าเว็บของผลิตภัณฑ์ และต้องอยู่ในช่วง 0.01 (1 เซนต์) ถึง 10000000.00 (10 ล้าน) อย่างไรก็ตาม ถ้าตรงตามเงื่อนไขต่อไปนี้ คุณอาจตั้งค่าราคาเป็น 0.0 (ศูนย์)
|
ProductPrice | ใช่ |
salePrice | ราคาขายของผลิตภัณฑ์ สําหรับรายการขาย ให้ตั้งค่าทั้งราคาขายและวันที่มีผลการขาย (ดู salePriceEffectiveDate ) ถ้าคุณตั้งค่าราคาขายแต่ไม่ใช่วันที่มีผลบังคับใช้ราคาขาย ราคาขายจะยังคงใช้ต่อไปจนกว่าผลิตภัณฑ์จะหมดอายุ หรือคุณกําหนดวันที่มีผลบังคับใช้ราคาขายต้องอยู่ในช่วง 0.01 (1 เซนต์) ถึง 10000000.00 (10 ล้าน) อย่างไรก็ตาม ถ้าตรงตามเงื่อนไขต่อไปนี้ คุณสามารถตั้งค่าราคาขายเป็น 0.0 (ศูนย์)
|
ProductPrice | ไม่ใช่ |
salePriceEffectiveDate | วันที่เริ่มต้นและวันที่สิ้นสุด UTC ของการขาย ระบุวันที่เฉพาะเมื่อคุณตั้งค่า salePrice เท่านั้นระบุวันที่เริ่มต้นและวันที่สิ้นสุดในรูปแบบ ISO 8601 ตัวอย่างเช่น 2016-04-05T08:00-08:00/2016-04-10T19:30-08:00 (ใช้เครื่องหมายทับ ('/') เพื่อแยกวันที่เริ่มต้นและวันที่สิ้นสุด) สําหรับข้อมูลเพิ่มเติม ให้ดูที่ salePrice ถ้าไม่ได้ระบุ วันที่ขายปัจจุบันจะถูกลบออกจากข้อเสนอ อย่าส่งผ่านค่าว่าง |
สตริง | ไม่ใช่ |
ProductPrice
กําหนดราคาหรือราคาขายของผลิตภัณฑ์
ชื่อ | ค่า | ชนิด |
---|---|---|
สกุล เงิน | สกุลเงินที่ใช้ในการระบุราคา ค่าที่เป็นไปได้:
|
สตริง |
ค่า | ราคาของผลิตภัณฑ์ | คู่ |
รหัสสถานะ HTTP
คําขออาจส่งกลับรหัสสถานะ HTTP ต่อไปนี้
รหัสสถานะ | คำอธิบาย |
---|---|
200 | สำเร็จ |
400 | การร้องขอไม่ถูกต้อง ค่าพารามิเตอร์คิวรีไม่ถูกต้องหรือบางอย่างในเนื้อความของการร้องขอไม่ถูกต้อง หากเกิดข้อผิดพลาด รายการชุดงานที่ล้มเหลวจะรวมข้อผิดพลาด |
401 | ไม่ได้รับอนุญาต ข้อมูลประจําตัวของผู้ใช้ไม่ถูกต้อง |
403 | Forbidden ผู้ใช้ไม่มีสิทธิ์ใช้ทรัพยากร |
404 | ไม่พบ |
409 | ขัดแย้งกัน ไม่สามารถดําเนินการให้เสร็จสมบูรณ์ได้ เนื่องจากมีข้อขัดแย้งกับสถานะปัจจุบันของทรัพยากร |
413 | ร้องขอเอนทิตีมากเกินไป การร้องขอมีขนาดเกินกว่าขนาดสูงสุดที่อนุญาต |
500 | ข้อผิดพลาดที่เซิร์ฟเวอร์ |