Endpoint Create an Order
Name
post_order
Description
Creates a new order. [API reference]
Related Tables
Parameters
Parameter | Required | Options | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
There are no parameters |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_I8
|
bigint
|
||
BillingAddressLine1 |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLine2 |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCity |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCompany |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCountry |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressFirstName |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLastName |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressPhone |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressProvince |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressZip |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressName |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressProvinceCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCountryCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLatitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLongitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
BrowserIp |
DT_WSTR
|
nvarchar(255)
|
255 | |
BuyerAcceptsMarketing |
DT_BOOL
|
bit
|
||
LineItems |
DT_NTEXT
|
nvarchar(MAX)
|
||
CancelReason |
DT_WSTR
|
nvarchar(255)
|
255 | |
CancelledAt |
DT_WSTR
|
nvarchar(255)
|
255 | |
CartToken |
DT_WSTR
|
nvarchar(255)
|
255 | |
CheckoutToken |
DT_WSTR
|
nvarchar(255)
|
255 | |
ClientDetailsAcceptLanguage |
DT_WSTR
|
nvarchar(255)
|
255 | |
ClientDetailsBrowserHeight |
DT_I4
|
int
|
||
ClientDetailsBrowserIp |
DT_WSTR
|
nvarchar(255)
|
255 | |
ClientDetailsBrowserWidth |
DT_I4
|
int
|
||
ClientDetailsSessionHash |
DT_WSTR
|
nvarchar(255)
|
255 | |
ClientDetailsUserAgent |
DT_WSTR
|
nvarchar(255)
|
255 | |
ClosedAt |
DT_WSTR
|
nvarchar(255)
|
255 | |
CompanyId |
DT_I8
|
bigint
|
||
CompanyLocationId |
DT_I8
|
bigint
|
||
CreatedAt |
DT_WSTR
|
nvarchar(255)
|
255 | |
Currency |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDiscounts |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDiscountsShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDiscountsShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDiscountsPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDiscountsPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDutiesShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDutiesShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDutiesPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalDutiesPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalPrice |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalPriceShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalPriceShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalPricePresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalPricePresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentSubtotalPrice |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentSubtotalPriceShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentSubtotalPriceShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentSubtotalPricePresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentSubtotalPricePresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalTax |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalTaxShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalTaxShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalTaxPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
CurrentTotalTaxPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
CustomerId |
DT_I8
|
bigint
|
||
CustomerLocale |
DT_WSTR
|
nvarchar(255)
|
255 | |
DT_WSTR
|
nvarchar(255)
|
255 | ||
EstimatedTaxes |
DT_BOOL
|
bit
|
||
FinancialStatus |
DT_WSTR
|
nvarchar(255)
|
255 | |
FulfillmentStatus |
DT_WSTR
|
nvarchar(255)
|
255 | |
LandingSite |
DT_WSTR
|
nvarchar(255)
|
255 | |
LocationId |
DT_I8
|
bigint
|
||
MerchantOfRecordAppId |
DT_I8
|
bigint
|
||
Name |
DT_WSTR
|
nvarchar(255)
|
255 | |
Note |
DT_NTEXT
|
nvarchar(MAX)
|
||
Number |
DT_I4
|
int
|
||
OrderNumber |
DT_I4
|
int
|
||
OriginalTotalDutiesShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
OriginalTotalDutiesShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
OriginalTotalDutiesPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
OriginalTotalDutiesPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentTermsAmount |
DT_DECIMAL
|
decimal(0,5)
|
||
PaymentTermsCurrency |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentTermsName |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentTermsType |
DT_WSTR
|
nvarchar(255)
|
255 | |
PaymentTermsDueInDays |
DT_I4
|
int
|
||
Phone |
DT_WSTR
|
nvarchar(255)
|
255 | |
PresentmentCurrency |
DT_WSTR
|
nvarchar(255)
|
255 | |
ProcessedAt |
DT_WSTR
|
nvarchar(255)
|
255 | |
ProcessingMethod |
DT_WSTR
|
nvarchar(255)
|
255 | |
ReferringSite |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLine1 |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLine2 |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCity |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCompany |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCountry |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressFirstName |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLastName |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressPhone |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressProvince |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressZip |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressName |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressProvinceCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCountryCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLatitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLongitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
SourceName |
DT_WSTR
|
nvarchar(255)
|
255 | |
SourceIdentifier |
DT_WSTR
|
nvarchar(255)
|
255 | |
SourceUrl |
DT_WSTR
|
nvarchar(255)
|
255 | |
SubtotalPrice |
DT_DECIMAL
|
decimal(0,5)
|
||
SubtotalPriceSetShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
SubtotalPriceSetShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
SubtotalPriceSetPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
SubtotalPriceSetPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
Tags |
DT_NTEXT
|
nvarchar(MAX)
|
||
TaxesIncluded |
DT_BOOL
|
bit
|
||
Test |
DT_BOOL
|
bit
|
||
Token |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalDiscounts |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalDiscountsSetShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalDiscountsSetShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalDiscountsSetPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalDiscountsSetPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalLineItemsPrice |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalLineItemsPriceSetShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalLineItemsPriceSetShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalLineItemsPriceSetPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalLineItemsPriceSetPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalOutstanding |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalPrice |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalPriceSetShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalPriceSetShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalPriceSetPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalPriceSetPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalShippingPriceSetShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalShippingPriceSetShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalShippingPriceSetPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalShippingPriceSetPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalTax |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalTaxSetShopMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalTaxSetShopMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalTaxSetPresentmentMoneyAmount |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalTaxSetPresentmentMoneyCurrencyCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalTipReceived |
DT_WSTR
|
nvarchar(255)
|
255 | |
TotalWeight |
DT_DECIMAL
|
decimal(0,5)
|
||
UpdatedAt |
DT_WSTR
|
nvarchar(255)
|
255 | |
UserId |
DT_I8
|
bigint
|
||
OrderStatusUrl |
DT_WSTR
|
nvarchar(255)
|
255 |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
BillingAddressLine1 |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLine2 |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCity |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCompany |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCountry |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressFirstName |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLastName |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressPhone |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressProvince |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressZip |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressName |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressProvinceCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressCountryCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLatitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
BillingAddressLongitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
BuyerAcceptsMarketing |
DT_BOOL
|
bit
|
||
LineItems |
DT_NTEXT
|
nvarchar(MAX)
|
||
CustomerId |
DT_I8
|
bigint
|
||
DT_WSTR
|
nvarchar(255)
|
255 | ||
EstimatedTaxes |
DT_BOOL
|
bit
|
||
FinancialStatus |
DT_WSTR
|
nvarchar(255)
|
255 | |
FulfillmentStatus |
DT_WSTR
|
nvarchar(255)
|
255 | |
LocationId |
DT_I8
|
bigint
|
||
MerchantOfRecordAppId |
DT_I8
|
bigint
|
||
Name |
DT_WSTR
|
nvarchar(255)
|
255 | |
Note |
DT_NTEXT
|
nvarchar(MAX)
|
||
Phone |
DT_WSTR
|
nvarchar(255)
|
255 | |
Currency |
DT_WSTR
|
nvarchar(255)
|
255 | |
PresentmentCurrency |
DT_WSTR
|
nvarchar(255)
|
255 | |
ProcessedAt |
DT_WSTR
|
nvarchar(255)
|
255 | |
ReferringSite |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLine1 |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLine2 |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCity |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCompany |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCountry |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressFirstName |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLastName |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressPhone |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressProvince |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressZip |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressName |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressProvinceCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressCountryCode |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLatitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
ShippingAddressLongitude |
DT_WSTR
|
nvarchar(255)
|
255 | |
SourceName |
DT_WSTR
|
nvarchar(255)
|
255 | |
SourceIdentifier |
DT_WSTR
|
nvarchar(255)
|
255 | |
SourceUrl |
DT_WSTR
|
nvarchar(255)
|
255 | |
Tags |
DT_NTEXT
|
nvarchar(MAX)
|
||
TaxesIncluded |
DT_BOOL
|
bit
|
||
TotalWeight |
DT_DECIMAL
|
decimal(0,5)
|
||
UserId |
DT_I8
|
bigint
|
||
InventoryBehaviour |
DT_WSTR
|
nvarchar(255)
|
255 | |
SendReceipt |
DT_BOOL
|
bit
|
||
SendFulfillmentReceipt |
DT_BOOL
|
bit
|
Examples
SSIS
Use Shopify Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Destination
This Endpoint belongs to the Orders table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to create an order:
There are no parameters to configure. |

ODBC application
Use these SQL queries in your ODBC application data source:
Insert a new order record
INSERT INTO Orders (BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressFirstName, BillingAddressLastName, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressName, BillingAddressProvinceCode, BillingAddressCountryCode, BuyerAcceptsMarketing, LineItems, CustomerId, Email, EstimatedTaxes, FinancialStatus, FulfillmentStatus, Name, Note, Phone, Currency, PresentmentCurrency, ProcessedAt, ReferringSite, ShippingAddressLine1, ShippingAddressLine2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressName, ShippingAddressProvinceCode, ShippingAddressCountryCode, Tags, TaxesIncluded, TotalWeight, SendReceipt, SendFulfillmentReceipt)
VALUES
('123 Main Street', 'Suite #54', 'Memphis', 'Acme, Inc.', 'United States', 'John', 'Doe', '4045559876', 'Tennessee', '38101', 'John Doe', 'GA', 'US', 1, '[{"title":"Super Strong Glue","price":24.99,"grams":"100","quantity":1,"tax_lines":[{"price":13.5,"rate":0.06,"title":"State tax"}]}]', 5945175474276, 'johndoe2@gmail.com', 1, 'pending', null, '#40294', 'This order needs to be expedited, so register it in the system as so.', '4045559876', 'USD', 'USD', '2023-02-27T11:00:00', 'https://referringsite.com', '123 Main Street', 'Suite #54', 'Memphis', 'Acme, Inc.', 'United States', 'John', 'Doe', '4045559876', 'Tennessee', '38101', 'John Doe', 'GA', 'US', NULL, 1, 20, 1, 1)
post_order
endpoint belongs to
Orders
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Insert a new order record
DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO Orders (BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressCompany, BillingAddressCountry, BillingAddressFirstName, BillingAddressLastName, BillingAddressPhone, BillingAddressProvince, BillingAddressZip, BillingAddressName, BillingAddressProvinceCode, BillingAddressCountryCode, BuyerAcceptsMarketing, LineItems, CustomerId, Email, EstimatedTaxes, FinancialStatus, FulfillmentStatus, Name, Note, Phone, Currency, PresentmentCurrency, ProcessedAt, ReferringSite, ShippingAddressLine1, ShippingAddressLine2, ShippingAddressCity, ShippingAddressCompany, ShippingAddressCountry, ShippingAddressFirstName, ShippingAddressLastName, ShippingAddressPhone, ShippingAddressProvince, ShippingAddressZip, ShippingAddressName, ShippingAddressProvinceCode, ShippingAddressCountryCode, Tags, TaxesIncluded, TotalWeight, SendReceipt, SendFulfillmentReceipt)
VALUES
(''123 Main Street'', ''Suite #54'', ''Memphis'', ''Acme, Inc.'', ''United States'', ''John'', ''Doe'', ''4045559876'', ''Tennessee'', ''38101'', ''John Doe'', ''GA'', ''US'', 1, ''[{"title":"Super Strong Glue","price":24.99,"grams":"100","quantity":1,"tax_lines":[{"price":13.5,"rate":0.06,"title":"State tax"}]}]'', 5945175474276, ''johndoe2@gmail.com'', 1, ''pending'', null, ''#40294'', ''This order needs to be expedited, so register it in the system as so.'', ''4045559876'', ''USD'', ''USD'', ''2023-02-27T11:00:00'', ''https://referringsite.com'', ''123 Main Street'', ''Suite #54'', ''Memphis'', ''Acme, Inc.'', ''United States'', ''John'', ''Doe'', ''4045559876'', ''Tennessee'', ''38101'', ''John Doe'', ''GA'', ''US'', NULL, 1, 20, 1, 1)';
EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];
post_order
endpoint belongs to
Orders
table(s), and can therefore be used via those table(s).