/syncOnlineSale

post

https://app.skuvault.com/api/sales/syncOnlineSale

Moderate throttling
Sync an online sale to SkuVault. If the sale does not exists, it's created. If it does exist, it's updated. ShippingStatus is required to create sale, but not update. ItemSkus is always required. Bulk version available: /syncOnlineSales

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
ShippingInfo.ShippingStatus
This field is required to create sales, but not update them.

Body Params

OrderId

string

required

The order ID. After order is synced it's status can be retrieved by the same ID. NOTE: You can create AND update sales that do not originate from the API if you provide the full SkuVault Sale ID in this parameter. In other words, if a sale originated from Magento, you can update it in the API if you provide the full SkuVault Sale ID.

MarketplaceId

string

Defaults to OrderId Value

Add a distinct marketplace ID to your sale.

OrderDateUtc

date

The UTC date and time order was created.

OrderTotal

double

Defaults to 0

Total order price. Can be different than the sum sale price of sold SKUs.

CheckoutStatus

string

View guide. One of: NotVisited, Visited, OnHold, Completed, CompletedOffline, Cancelled

PaymentStatus

string

View guide. One of: NotSubmitted, Submitted, Deposited, Cleared, Failed

SaleState

string

View guide. One of: Active, Cancelled, Archived

AutoRemoveInfo

object

Picks against a sale when sale is marked as "Completed".

Notes

string

Sale notes associated with this order.

ItemSkus

object

List of merchant-fulfilled items in the order. Required only if FulfilledItems is missing.

FulfilledItems

object

List of 3PL/FBA-fulfilled items in the order.

ShippingInfo

object

Shipping information about sale, such as shipped status, carrier, class, and destination.

ChannelType

string

Channel Type

ChannelAccountId

int64

Channel Account Id

TenantToken

string

required

from getTokens

UserToken

string

required

from getTokens

Headers

Content-Type

string

Defaults to application/json

application/json

string

Defaults to application/json

application/json

Response

🚧ShippingInfo.ShippingStatus

200200

🚧
ShippingInfo.ShippingStatus