Orders
Returns information for Orders being placed to your store.
Select
To query from Orders table you need to specify either Date and DateRangeSearchColumn or OrderNo filters. By default, if no filters are specified, the driver will return orders with OrderDate within the last 730 days (the maximum range that it returns values for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The 本製品 will use the Ponparemall API to process WHERE clause conditions built for these fields. The rest of the filter is executed client side.
- OrderNo, CardBrand, CardPaymentMethod and CCPaymentStatus columns support = and IN operators.
- OrderStatus, OrderMemo, EncloseKind, NxDayDlvFlg, CouponUse, FirstName, LastName, NameSearchColumn, Tel, TelSearchColumn, ItemId, ItemName, PointUse, SalesRoute, UpdatedCardIconFlg and DateRangeSearchColumn columns support the = operator.
- Date column supports the >=,<= and = operators.
SELECT * FROM Orders WHERE OrderNo IN ('403593', '403594', '403595')"The following query will return Orders having the specified status and OrderDate from 2018-01-01 till the current date.
SELECT * FROM Orders WHERE OrderStatus = 'status' AND Date >= '2018-01-01'The following query will return Orders having ShipmentDate from 2018-01-01 till the current date.
SELECT * FROM Payments WHERE Date >= '2018-01-01' AND DateRangeSearchColumn = '2'The following query will return Orders having customer's first name John:
SELECT * FROM Payments WHERE FirstName > 'John' AND NameSearchColumn = '1'
Update
To update an order you need to specify the OrderNo. All the fields that are not readonly can be updated.
UPDATE Orders SET DlvKind = 1, DlvDesiredDate = '2019-05-01', GiftApplyFlg = true, UseTerminal = 0 WHERE OrderNo = '403593-201904081443-122177'
Columns
Name | Type | ReadOnly | Description |
OrderNo [KEY] | String | True | |
OrderStatus | String | False | |
OrderDateTime | Datetime | True | |
PaymentStatus | String | False | |
DepositDate | Date | False | |
SendDate | Date | False | |
DlvKind | String | False | |
DlvDesiredDate | Date | False | |
DlvDesiredTimeZoneKind | String | False | |
DlvDesiredTimeZoneFrom | String | False | |
DlvDesiredTimeZoneTo | String | False | |
ShopUserNameInCharge | String | False | |
OrderMemo | String | False | |
MessageToCustomer | String | True | |
UseTerminal | String | True | |
MailcarrierCode | String | True | |
GiftApplyFlg | Boolean | False | |
OrderNote | String | False | |
TaxRate | String | False | |
DlvAddrCautionFlg | Boolean | True | |
YellowUserFlg | Boolean | True | |
MemberKind | String | True | |
EnclosableFlg | Boolean | True | |
ItemAmount | Decimal | True | |
TaxAmount | Decimal | True | |
DlvFee | Decimal | False | |
PaymentFee | Integer | False | |
TotalAmount | Decimal | True | |
UsePointAmount | Decimal | True | |
UseCouponTotalAmount | Decimal | True | |
UseCouponShopAmount | Decimal | True | |
UseCouponOtherAmount | Decimal | True | |
UseCouponTotalCnt | Integer | True | |
UseCouponShopCnt | Integer | True | |
UseCouponOtherCnt | Integer | True | |
TotalPymntAmount | Decimal | True | |
TotalPymntAmountInit | Decimal | True | |
Noshi | String | False | |
EncloseKind | String | True | |
EncloseOrderNo | String | True | |
EncloseItemAmount | Decimal | False | |
EncloseTaxAmount | Decimal | False | |
EncloseDlvFee | Decimal | False | |
EnclosePymntFee | Decimal | False | |
EncloseTotalAmount | Decimal | False | |
EncloseUsePointAmount | Decimal | False | |
EncloseUseCouponAmount | Decimal | False | |
EncloseTotalPymntAmount | Decimal | False | |
CardUpdatingIconFlg | Boolean | False | |
CardUpdatedIconFlg | Boolean | False | |
FraudOrderAlert | String | False | |
NxDayDlvFlg | String | False | |
CouponUse | String | True | |
Date | Date | True | |
DateRangeSearchColumn | String | True | |
FirstName | String | True | |
LastName | String | True | |
NameSearchColumn | String | True | |
Tel | String | True | |
TelSearchColumn | String | True | |
ItemId | String | True | |
ItemName | String | True | |
PointUse | String | True | |
SalesRoute | String | True | |
UpdatedCardIconFlg | String | True |