JDBC Driver for Yahoo Shopping

Build 20.0.7587


Returns data from a sample table.


The 本製品 will use the Yahoo Shopping API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the 本製品.

  • OrderId AND SellerId support the = operator.
For example, the following queries are processed server side:
SELECT * FROM OrderDetails WHERE OrderId = 'store_000001'

SELECT * FROM OrderDetails WHERE OrderId = 'store_000001' AND SellerId = 'store' 
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause unfiltered data to be pushed.


Insert is not supported by OrderDetails


Yahoo Shopping allows updates for the OrderStatus, IsPointFix, CancelReason, CancelReasonDetail, OperationUser, PrintSlipTime, PrintDeliveryTime, PrintBillTime, BuyerComments, SellerComments, Notes, PayCharge, ShipCharge, GiftWrapCharge, Discount columns.

Update OrderDetails SET OrderStatus = 2, IsPointFix = 'true', CancelReason = 110, CancelReasonDetail = ' detail for canceling here ', OperationUser = 'API', PrintSlipTime = '2018-05-27T10:51:18.000+02:00', PrintDeliveryTime= '2018-06-27T10:51:18.000+02:00', PrintBillTime= '2018-07-27T10:51:18.000+02:00' , BuyerComments = 'comments here' , SellerComments = 'seller comments', Notes = 'some notes ', PayCharge = 1, ShipCharge = 2, GiftWrapCharge = 0, Discount = 4 Where OrderId = 'store-10000003'


Delete is not supported by OrderDetails


Name Type ReadOnly References Description
OrderId [KEY] String False


Order Id.

SellerId String False

Store account.

OrderTime Datetime True

The date and time when the order was made.

OrderStatus Integer False

Status of the order. 1: During reservation, 2: In process, 3: Hold, 4: Cancel, 5: Completed.

使用できる値は次のとおりです。0, 1, 2, 3, 4, 5, 8

CancelReason Integer False

Cancellation reason: Order Cancellation - 100: Cancel, 110: Returned Item, 120: Not Received, 130: Address Unknown, 140: Receiving Refused, 150: No Connection, 160: Duplicate Order, 170: Payment Unavailable, 180: Other, 300: Mistakenly Ordered, 310: Customer Using Points They Forgot to Use, 320: Customer Using Coupon They Forgot to Use, 330: Customer Found Cheaper Price, 340: Shipping Cost Too High, 350: Change of Shipping Destination, 360: Change of Shipping Method, 370: Change of Payment Method, 380: Credit Card Not Available, | Store convenience - 200: Settlement Method Convenience, 210: Missing Item, 220: Discontinued, 230: Other | Other - 0: Cancel reason n/a System cancellation | blank: Order not canceled.

CancelReasonDetail String False

The reason why the store has entered a cancellation reason when the reason is Store Convenience 230 (Other)

IsPointFix Boolean False

Required on an Update. True: Points are finalized. False: The point is not fixed.

OperationUser String False

The registered name of Yahoo! JAPAN business ID who carried out update work.

ParentOrderId String True

The splitting order ID when an order is split.

ChildOrderId String True

The second splitting order ID when an order is split.

MobileCarrierName String True

The type of mobile carrier.

NeedSnl Boolean True

Store newsletter opt-in flag.

LastUpdateTime Datetime True

The last modification date of order information.

SuspectMessage String True

A message when an order is judged as mischievous.0: Non-naughty order, 1: Mischievous order, 2: Mischievious canceled order.

SendConfirmTime Datetime True

The date and time of sending the order confirmation email sent when the order is newly entered.

SendPayTime Datetime True

The mail transmission date sent at the time of settlement.

PrintSlipTime Datetime False

The date and time when the order slip was output.

PrintDeliveryTime Datetime False

The date and time when we output the invoice.

PrintBillTime Datetime False

The date and time when the invoice was output.

BuyerComments String False

The comment string displayed by the buyer.

SellerComments String False

The comment string displayed by the store in the store.

Notes String False

A memo in the store when the store is entered with the order management tool.

Referer String True

Referrer information covering domain, search keywords, etc.

EntryPoint String True

The URL of the store page where the buyer entered the target store.

HistoryId String True

An ID that manages the update history of orders.

UsageId String True

The coupon usage ID.

UseCouponData String True

Detailed information on the coupon information.

TotalCouponDiscount Integer True

Of the amount discounted by the store coupon of all the products associated with one order, this becomes the discount total value other than the shipping fee.

ShippingCouponFlg Integer True

Free shipping availability. 0: None, 1: Present.

ShippingCouponDiscount Integer True

It is the discount amount of the carriage when applying free shipping coupons.

CampaignPoints String True

Comma separated list of breakdown points.

IsMultiShip Boolean True

Indicates if there is a multiple shipping order.

MultiShipId String True

ID that identifies multiple delivery orders.

PayCharge Integer False

The fee set by the store (cash on delivery commission etc.). The settlement fee of Yahoo! settlement is different.

ShipCharge Integer False

Shipping fee (postage free coupon discount after deduction).

GiftWrapCharge Integer False

Gift wrapping fee.

Discount Integer False

Discount. The value entered in the price discount column on the store creator Pro after the store side is entered.

Adjustments Integer False

Adjustment amount.

SettleAmount Integer True

The same value as the total amount (TotalPrice).

UsePoint Integer True

Number of points used.

TotalPrice Integer True

Subtotal - usage point + gift wrapping fee + fee - discount + postage + adjustment amount - mall coupon discount amount.

IsGetPointFixAll Boolean True

Indicates whether or not the process of finalizing the grant points of all lines (goods) has been completed.

TotalMallCouponDiscount Integer True

Indicates the total value of the amount discounted at the mall coupon.

SettlePayAmount Integer True

When the order is split, this will not reflect the split amount. The total amount will reflect this.

IsLogin Boolean True

Login order.

FspLicenseCode String True

For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.

FspLicenseName String True

For details on the star club, please see the following page. http://starclub.yahoo.co.jp/.

GuestAuthId String True

Guest authorization Id for guest orders only.

YamatoCoopStatus Integer True

使用できる値は次のとおりです。0, 1, 2, 3, 4

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587