skuvault api definition

skuvault-api.json

[{"url":"\/addItem","method":"post","params":[{"name":"Sku","type":"string","desc":"Product SKU. Used when CODE is blank."},{"name":"Code","type":"string","desc":"Product CODE. Used when SKU is blank."},{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"LocationCode","type":"string","desc":"The warehouse location inventory will be added to."},{"name":"Quantity","type":"int","desc":"Quantity to add."},{"name":"Reason","type":"string","desc":"Transaction reason must exist in SkuVault"},{"name":"Note","type":"string","desc":"Transaction Note"},{"name":"SerialNumbers","type":"array_string","desc":"Serial Numbers. Required only for serialized products. Amount of Serial Numbers should correspond to the Quantity."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/addItemBulk","method":"post","params":[{"name":"Items","type":"array_object","desc":"Max 100"},{"name":"Items.Sku","type":"string","desc":"Product SKU. Required if CODE is omitted."},{"name":"Items.Code","type":"string","desc":"Product code."},{"name":"Items.WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"Items.LocationCode","type":"string","desc":""},{"name":"Items.Quantity","type":"int","desc":""},{"name":"Items.Reason","type":"string","desc":"Transaction reason must exist in SkuVault"},{"name":"Items.Note","type":"string","desc":"Transaction note"},{"name":"Items.SerialNumbers","type":"array_string","desc":"Serial Numbers. Required only for serialized products. Amount of Serial Numbers should correspond to the Quantity."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/addShipments","method":"post","params":[{"name":"Shipments","type":"object","desc":"List of Shipments"},{"name":"Shipments.SaleId","type":"string","desc":"If provided, the Sale ID must exist in SkuVault"},{"name":"Shipments.Source","type":"string","desc":"Where the shipping information came from."},{"name":"Shipments.TrackingNumber","type":"string","desc":"The unique identifier for a shipment from a particular Carrier."},{"name":"Shipments.Carrier","type":"string","desc":"The shipping company responsible for taking the delivery from Point A to Point B."},{"name":"Shipments.Class","type":"string","desc":"The level of service the carrier was paid for."},{"name":"Shipments.Type","type":"string","desc":"The type of Shipment that is being transported to\/from the warehouse. Accepts: \"Fulfillment\", \"Return\", \"Exchange\", \"Replacement\", \"Warranty\""},{"name":"Shipments.Status","type":"string","desc":"\"Created\" means the Shipment has been given a tracking number. \"Voided\" will void the Shipment."},{"name":"Shipments.AlternateId","type":"string","desc":"Alternate ID"},{"name":"Shipments.ManifestId","type":"string","desc":"A list of Shipments"},{"name":"Shipments.Note","type":"string","desc":"A note for the shipment."},{"name":"Shipments.TotalWeight","type":"double","desc":"Accepts decimal. This is the total weight of the shipment including all parcels in the shipment."},{"name":"Shipments.WeightUnit","type":"string","desc":"Units for the weight measurement. Accepts: \"g\", \"oz\", \"lbs\", \"kgs\""},{"name":"Shipments.TrackingUrl","type":"string","desc":"The URL where the Carrier provides tracking information for the shipment."},{"name":"Shipments.CreatedDate","type":"datetime","desc":"Date and Time that the shipment was created."},{"name":"Shipments.EstimatedShipDate","type":"datetime","desc":"At time of shipment, when order is expected to be picked up by the carrier."},{"name":"Shipments.EstimatedDeliveryDate","type":"datetime","desc":"At time of shipment, when order is expected to deliver."},{"name":"Shipments.ShippedFrom","type":"object","desc":"Where the shipment was picked up by the Carrier \/ Shipped from."},{"name":"Shipments.ShippedFrom.WarehouseId","type":"string","desc":"Warehouse ID. The ID must exist in SkuVault. If Shipments.ShippedFrom.Is3PL is \"true\", ID must belong to an external warehouse."},{"name":"Shipments.ShippedFrom.Is3PL","type":"boolean","desc":"True or False"},{"name":"Shipments.ShippedFrom.Address","type":"object","desc":"Address where the Shipment is coming from."},{"name":"Shipments.ShippedFrom.Address.FirstName","type":"string","desc":"First Name"},{"name":"Shipments.ShippedFrom.Address.LastName","type":"string","desc":"Last Name"},{"name":"Shipments.ShippedFrom.Address.MiddleName","type":"string","desc":"Middle Name"},{"name":"Shipments.ShippedFrom.Address.Company","type":"string","desc":"Company"},{"name":"Shipments.ShippedFrom.Address.Email","type":"string","desc":"Email"},{"name":"Shipments.ShippedFrom.Address.Address1","type":"string","desc":"Address 1"},{"name":"Shipments.ShippedFrom.Address.Address2","type":"string","desc":"Address 2"},{"name":"Shipments.ShippedFrom.Address.City","type":"string","desc":"City"},{"name":"Shipments.ShippedFrom.Address.Region","type":"string","desc":"Region"},{"name":"Shipments.ShippedFrom.Address.Country","type":"string","desc":"Country"},{"name":"Shipments.ShippedFrom.Address.PostalCode","type":"string","desc":"Postal Code"},{"name":"Shipments.Costs","type":"array_object","desc":"The various costs associated with a Shipment type"},{"name":"Shipments.Costs.CostType","type":"string","desc":"The type of Shipping Cost appended to the shipment. Accepts: \"Transportation\", \"Insurance\", \"Sales tax\", \"Gift Wrap\", \"Recycling Fee\", \"VAT Shipping\", \"VAT Gift Wrap\", \"Import Shipping\", \"Import Tax\", \"ThreePL\""},{"name":"Shipments.Costs.Amount","type":"double","desc":"The Amount value of the Cost. Accepts decimals."},{"name":"Shipments.Costs.CurrencyIsoCode","type":"string","desc":"The type of currency associated with the cost."},{"name":"Shipments.Parcels","type":"array_object","desc":"List of one or more parcels within the shipment."},{"name":"Shipments.Parcels.Number","type":"int","desc":"The parcel number for each individual parcel."},{"name":"Shipments.Parcels.Weight","type":"double","desc":"Accepts decimals. The total weight of the parcel."},{"name":"Shipments.Parcels.WeightUnit","type":"string","desc":"The unit of measurement used. Accepts: \"g\", \"oz\", \"lbs\", \"kgs\"."},{"name":"Shipments.Parcels.Note","type":"string","desc":"Note for the Parcel."},{"name":"Shipments.Parcels.Items","type":"array_object","desc":"List of items and quantities in the shipment."},{"name":"Shipments.Parcels.Items.Sku","type":"string","desc":"Sku for the item."},{"name":"Shipments.Parcels.Items.Quantity","type":"int","desc":"Number of items associated with that SKU."},{"name":"Shipments.Parcels.Dimensions","type":"object","desc":"Various dimensions of the parcel."},{"name":"Shipments.Parcels.Dimensions.Height","type":"double","desc":"Height. Accepts decimals."},{"name":"Shipments.Parcels.Dimensions.Width","type":"double","desc":"Width. Accepts decimals."},{"name":"Shipments.Parcels.Dimensions.Length","type":"double","desc":"Length. Accepts decimals."},{"name":"Shipments.Parcels.Dimensions.Unit","type":"string","desc":"Unit of Measurement. Accepts: \"in\", \"ft\", \"yd\", \"mm\", \"cm\", \"m\"."},{"name":"Shipments.LandedCosts","type":"array_object","desc":"The total cost a line item is responsible for."},{"name":"Shipments.LandedCosts.Sku","type":"string","desc":"SKU"},{"name":"Shipments.LandedCosts.Amount","type":"int","desc":"Cost value of SKU item."},{"name":"Shipments.LandedCosts.CurrencyIsoCode","type":"string","desc":"Type of Currency for Amount"},{"name":"TenantToken","type":"string","desc":"Tenant Token to access account"},{"name":"UserToken","type":"string","desc":"User Token to access account"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/createBrands","method":"post","params":[{"name":"Brands","type":"array_object","desc":"Brands to be created, max 100"},{"name":"Brands.Name","type":"string","desc":"Name of Brand"},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/createHolds","method":"post","params":[{"name":"Holds","type":"array_object","desc":"Contains your list of SKUs & hold parameters."},{"name":"Holds.Sku","type":"string","desc":"The SKU to place on hold."},{"name":"Holds.Quantity","type":"int","desc":"The quantity."},{"name":"Holds.ExpirationDateUtc","type":"datetime","desc":"When this hold expires"},{"name":"Holds.Description","type":"string","desc":"A description of the hold, eg: \"Summer Flash Sale\""},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/createKit","method":"post","params":[{"name":"Sku","type":"string","desc":"Kit SKU"},{"name":"Title","type":"string","desc":"Kit Title"},{"name":"Code","type":"string","desc":"Kit Code. Will be autogenerated if parameter is not included or if value is blank."},{"name":"KitLines","type":"array_object","desc":"Kit Line Items; Max 500 lines per kit."},{"name":"KitLines.LineName","type":"string","desc":"The name of the line for internal use."},{"name":"KitLines.Combine","type":"string","desc":"Substitute combine option. 1) Use up by priority. 2) Use single SKU if possible. 3) Never combine."},{"name":"KitLines.Quantity","type":"string","desc":"The quantity of the line item."},{"name":"KitLines.Items","type":"array_string","desc":"List of Codes or SKUs that make up the line. More that one indicates substitutes."},{"name":"AllowCreateAp","type":"boolean","desc":"If true, will allow kit creation if a product with the same SKU exists, turning the product into an Assembled Product."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/createPO","method":"post","params":[{"name":"PoNumber","type":"string","desc":"The number you wish to give this PO. If not provided, will automatically be generated."},{"name":"SupplierName","type":"string","desc":"The vendor you are purchasing from."},{"name":"OrderDate","type":"datetime","desc":"The date the PO was placed."},{"name":"TermsName","type":"string","desc":""},{"name":"OrderCancelDate","type":"datetime","desc":"The date you wish to cancel the PO on if it has not been received."},{"name":"Payments","type":"array_object","desc":""},{"name":"Payments.PaymentName","type":"string","desc":"Only accepted values are \"Shipping\" or \"Tax\"."},{"name":"Payments.Amount","type":"double","desc":""},{"name":"Payments.Note","type":"string","desc":""},{"name":"SentStatus","type":"string","desc":"Sent Status - NotSent, Sent, and NeedToResend"},{"name":"PaymentStatus","type":"string","desc":"Payment Status - NonePaid, PartiallyPaid, and FullyPaid"},{"name":"ShippingCarrierClass","type":"object","desc":""},{"name":"ShippingCarrierClass.Carrier","type":"string","desc":"The shipping carrier."},{"name":"ShippingCarrierClass.Class","type":"string","desc":"The shipping class."},{"name":"ShipToWarehouse","type":"string","desc":"This is the code of the warehouse in SkuVault. You can specify a warehouse that PO is for."},{"name":"ShipToAddress","type":"string","desc":"This is the Address Name of the warehouse in SkuVault. The address must exist for the ShipToWarehouse."},{"name":"ArrivalDueDate","type":"datetime","desc":"The date the PO is expected to arrive."},{"name":"RequestedShipDate","type":"datetime","desc":""},{"name":"TrackingInfo","type":"string","desc":""},{"name":"PublicNotes","type":"string","desc":"Notes for use on the PO template."},{"name":"PrivateNotes","type":"string","desc":"Notes for internal use only."},{"name":"LineItems","type":"array_object","desc":"At least one line item is required."},{"name":"LineItems.SKU","type":"string","desc":"The SKU you are purchasing."},{"name":"LineItems.Quantity","type":"int","desc":"The total quantity of the SKU you are purchasing."},{"name":"LineItems.QuantityTo3PL","type":"int","desc":"The quantity of the SKU you are sending to 3PL."},{"name":"LineItems.Cost","type":"double","desc":"The cost of the SKU you are purchasing. If left blank, it will use the Supplier's Cost if the supplier is Active. Otherwise it will use the product's default cost (Product Cost Field)."},{"name":"LineItems.PrivateNotes","type":"string","desc":""},{"name":"LineItems.PublicNotes","type":"string","desc":""},{"name":"LineItems.Variant","type":"string","desc":""},{"name":"LineItems.Identifier","type":"string","desc":"Any other identifier used for the item."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/createProduct","method":"post","params":[{"name":"Sku","type":"string","desc":"The SKU to give the product."},{"name":"Description","type":"string","desc":"This is the \"Title\" of your product."},{"name":"ShortDescription","type":"string","desc":"Limit 1000 characters"},{"name":"LongDescription","type":"string","desc":"Limit 65665 characters."},{"name":"Classification","type":"string","desc":"Must exist in SkuVault."},{"name":"Supplier","type":"string","desc":"Primary Supplier for the product. Supplier must exist in SkuVault."},{"name":"Brand","type":"string","desc":"Must exist in SkuVault."},{"name":"Code","type":"string","desc":"Barcode number."},{"name":"PartNumber","type":"string","desc":"Manufacturer part number."},{"name":"Cost","type":"double","desc":"Accepts decimal; Your overall cost on hand for that product. Used for a default (fallback) cost field or for the cost averaging feature in SkuVault."},{"name":"SalePrice","type":"mixed","desc":"Accepts decimal; Your selling price per unit"},{"name":"RetailPrice","type":"double","desc":"Accepts decimal; MSRP per unit"},{"name":"Weight","type":"double","desc":"Accepts decimal"},{"name":"WeightUnit","type":"string","desc":"One of: \"lbs\", \"kgs\", \"oz\", \"g\""},{"name":"VariationParentSku","type":"string","desc":""},{"name":"ReorderPoint","type":"int","desc":"The point at which you should reorder quantity."},{"name":"MinimumOrderQuantity","type":"int","desc":""},{"name":"MinimumOrderQuantityInfo","type":"string","desc":""},{"name":"Note","type":"string","desc":""},{"name":"Statuses","type":"array_string","desc":""},{"name":"Pictures","type":"array_string","desc":"List of picture urls"},{"name":"Attributes","type":"object","desc":"Dictionary where key is attribute name and value is attribute value"},{"name":"AllowCreateAp","type":"boolean","desc":"Creates an Assembled Product if the kit already exists."},{"name":"SupplierInfo","type":"array_object","desc":"Array that houses supplier information."},{"name":"SupplierInfo.SupplierName","type":"string","desc":"The name of your supplier in SkuVault. It must exist in SkuVault and at least one supplier is required."},{"name":"SupplierInfo.isPrimary","type":"boolean","desc":"At least 1 supplier must be specified as primary (true)."},{"name":"SupplierInfo.Cost","type":"double","desc":"This is the supplier's cost for that item."},{"name":"SupplierInfo.SupplierPartNumber","type":"string","desc":"Supplier's part number for that product. It is blank by default."},{"name":"SupplierInfo.LeadTime","type":"int","desc":"Supplier's lead time."},{"name":"SupplierInfo.isActive","type":"boolean","desc":"If a supplier is active, we will use the supplier information (Cost, Supplier Part Number, etc.) when creating a Purchase Order."},{"name":"IsSerialized","type":"boolean","desc":"If true, creates serialized product."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"},{"name":"Client","type":"string","desc":"Only active clients, must exists in UI"}]},{"url":"\/createProducts","method":"post","params":[{"name":"Items","type":"array_object","desc":"List of SKUs to create as products. Max 100 per call."},{"name":"Items.Sku","type":"string","desc":"The SKU to give your product."},{"name":"Items.Description","type":"string","desc":"Now known as \"Title\" in the UI."},{"name":"Items.ShortDescription","type":"string","desc":"Limit 1000 characters."},{"name":"Items.LongDescription","type":"string","desc":"Limit 65665 characters."},{"name":"Items.Classification","type":"string","desc":"Must exist in SkuVault."},{"name":"Items.Supplier","type":"string","desc":"Primary Supplier for the product. Supplier must exist in SkuVault."},{"name":"Items.Brand","type":"string","desc":"Must exist in SkuVault."},{"name":"Items.Code","type":"string","desc":"Barcode number."},{"name":"Items.PartNumber","type":"string","desc":"Manufacturer part number."},{"name":"Items.Cost","type":"double","desc":"Accepts decimal; Your overall cost on hand for that product. Used for a default (fallback) cost field or for the cost averaging feature in SkuVault."},{"name":"Items.SalePrice","type":"double","desc":"Accepts decimal; Your selling price per unit"},{"name":"Items.RetailPrice","type":"double","desc":"Accepts decimal; MSRP per unit"},{"name":"Items.Weight","type":"double","desc":"Accepts decimal."},{"name":"Items.WeightUnit","type":"string","desc":"One of: \"lbs\", \"kgs\", \"oz\", \"g\""},{"name":"Items.VariationParentSku","type":"string","desc":""},{"name":"Items.ReorderPoint","type":"int","desc":"The point at which you should reorder quantity."},{"name":"Items.MinimumOrderQuantity","type":"int","desc":""},{"name":"Items.MinimumOrderQuantityInfo","type":"string","desc":""},{"name":"Items.Note","type":"string","desc":"A note to place on the SKU."},{"name":"Items.Statuses","type":"array_string","desc":"Attach tags or statuses to this SKU. The status must exist in SkuVault."},{"name":"Items.Pictures","type":"array_string","desc":"List of picture urls."},{"name":"Items.Attributes","type":"object","desc":"Dictionary list where AttributeName is key, AttributeValue is value. AttributeName must exist under Classification."},{"name":"Items.AllowCreateAp","type":"boolean","desc":"Creates an Assembled Product if the kit already exists."},{"name":"Items.SupplierInfo","type":"array_object","desc":"Array that houses supplier information."},{"name":"Items.SupplierInfo.SupplierName","type":"string","desc":"The name of your supplier in SkuVault. It must exist in SkuVault and at least one supplier is required."},{"name":"Items.SupplierInfo.SupplierPartNumber","type":"string","desc":"Supplier's part number for that product. It is blank by default."},{"name":"Items.SupplierInfo.Cost","type":"double","desc":"This is the supplier's cost for that item."},{"name":"Items.SupplierInfo.LeadTime","type":"int","desc":"Supplier's lead time."},{"name":"Items.SupplierInfo.isActive","type":"boolean","desc":"If a supplier is active, we will use the supplier information (Cost, Supplier Part Number, etc.) when creating a Purchase Order."},{"name":"Items.SupplierInfo.isPrimary","type":"boolean","desc":"At least 1 supplier must be specified as primary (true)."},{"name":"Items.IsSerialized","type":"boolean","desc":"If true, creates serialized product."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"},{"name":"Client","type":"string","desc":"Only active clients, must exists in UI"}]},{"url":"\/createSuppliers","method":"post","params":[{"name":"Suppliers","type":"array_object","desc":""},{"name":"Suppliers.Name","type":"string","desc":""},{"name":"Suppliers.EmailTemplateSubject","type":"string","desc":""},{"name":"Suppliers.EmailTemplateMessage","type":"string","desc":""},{"name":"Suppliers.Emails","type":"array_string","desc":""},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getAvailableQuantities","method":"post","params":[{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":"Inventory modified after UTC DateTime"},{"name":"ModifiedBeforeDateTimeUtc","type":"datetime","desc":"Inventory modified before UTC DateTime"},{"name":"PageNumber","type":"int","desc":"The page number to retrieve. Page number starts with 0."},{"name":"PageSize","type":"int","desc":"Must be between 1000 and 5000."},{"name":"ExpandAlternateSkus","type":"boolean","desc":"If true, we will return alternate SKUs as a list instead of separate line items."},{"name":"TenantToken","type":"string","desc":"Acquired from [getTokens.](https:\/\/dev.skuvault.com\/docs\/gettokens)"},{"name":"UserToken","type":"string","desc":"Acquired from [getTokens.](https:\/\/dev.skuvault.com\/docs\/gettokens)"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getBrands","method":"post","params":[{"name":"PageNumber","type":"int","desc":"Page number, 1,000 results per page. Page number starts with 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getClassifications","method":"post","params":[{"name":"PageNumber","type":"int","desc":"Page number. 1,000 results per page. Page number starts with 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getExternalWarehouseQuantities","method":"post","params":[{"name":"GetTotalFbaQuantities","type":"boolean","desc":"Will return the sum of the FBA quantities and warehouses that are associated with an Amazon account in SkuVault. NOTE: If true, then WarehouseId parameter will be ignored."},{"name":"PageNumber","type":"int","desc":"The page number to be retrieved starting with 0. Defaults to page 0. Page number starts with 0."},{"name":"PageSize","type":"int","desc":"The number of SKUs to return per page. Can be any number between 1000 and 100000."},{"name":"WarehouseId","type":"int","desc":"*from [getExternalWarehouses](doc:getexternalwarehouses)*"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getExternalWarehouses","method":"post","params":[{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getHandlingTime","method":"post","params":[{"name":"Tenant Token","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"User Token","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":""},{"name":"Accept","type":"string","desc":""}]},{"url":"\/getIncomingItems","method":"post","params":[{"name":"PageNumber","type":"int","desc":"Page number with 0 being the first page. Defaults to 0."},{"name":"TenantToken","type":"string","desc":"Tenant Token to access account"},{"name":"UserToken","type":"string","desc":"User Token to access account"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getIntegrations","method":"post","params":[{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getInventoryByLocation","method":"post","params":[{"name":"IsReturnByCodes","type":"boolean","desc":"List products by code instead of SKU."},{"name":"PageNumber","type":"int","desc":"10,000 products per page. Page number starts with 0."},{"name":"PageSize","type":"int","desc":"Value should be between 1000 and 10000."},{"name":"ProductCodes","type":"array_string","desc":"Filter by product codes."},{"name":"ProductSKUs","type":"array_string","desc":"Filter by product SKUs."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getItemQuantities","method":"post","params":[{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":"Product inventory modified after date time in UTC."},{"name":"ModifiedBeforeDateTimeUtc","type":"datetime","desc":"Product inventory modified before date time in UTC."},{"name":"ProductCodes","type":"array_string","desc":"Filter results by a list of Codes, limited to 10000"},{"name":"PageNumber","type":"int","desc":"Defaults to 0."},{"name":"PageSize","type":"int","desc":"Value should be between 1000 and 10000."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getKitQuantities","method":"post","params":[{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":"Kit inventory modified after date time in UTC."},{"name":"ModifiedBeforeDateTimeUtc\" ModifiedBeforeDateTimeUtc","type":"datetime","desc":"Kit inventory modified before date time in UTC."},{"name":"PageNumber","type":"int","desc":"10,000 kits per page. Page number starts with 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getKits","method":"post","params":[{"name":"AvailableQuantityModifiedAfterDateTimeUtc","type":"datetime","desc":"Modified  kit quantities after date time in UTC."},{"name":"AvailableQuantityModifiedBeforeDateTimeUtc","type":"datetime","desc":"Modified kit quantities before date time in UTC."},{"name":"GetAvailableQuantity","type":"boolean","desc":"If false, AvailableQuantity will always return 0."},{"name":"IncludeKitCost","type":"boolean","desc":"If true, then return cost for the kit with response"},{"name":"KitSKUs","type":"array_string","desc":"Filter results by a list of SKUs."},{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":""},{"name":"ModifiedBeforeDateTimeUtc","type":"datetime","desc":""},{"name":"PageNumber","type":"int","desc":"Defaults to 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getLocations","method":"post","params":[{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getOnlineSaleStatus","method":"post","params":[{"name":"OrderIds","type":"array_string","desc":"List of IDs to get status on. Only 10000 orders can be accessed at at a time. All extra IDs will be ignored."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getPOs","method":"post","params":[{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":""},{"name":"ModifiedBeforeDateTimeUtc","type":"datetime","desc":""},{"name":"Status","type":"string","desc":"We will return all POs that are not completed by Default. To get completed PO's, you must intentionally specify in the call. Possible values are: NoneReceived, PartiallyReceived, Completed, Cancelled"},{"name":"PageNumber","type":"int","desc":"10,000 POs are returned per page. Defaults to 0."},{"name":"IncludeProducts","type":"boolean","desc":"Returns incoming product details in separate array."},{"name":"PONumbers","type":"array_string","desc":"A list of PO Numbers you can request data for. If using this parameter, the Date parameters and Status parameter is ignored."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getProduct","method":"post","params":[{"name":"ProductCode","type":"string","desc":"Optional product Code. Either Code or SKU should be provided."},{"name":"ProductSKU","type":"string","desc":"Optional product SKU. Either SKU or Code should be provided."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getProducts","method":"post","params":[{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":"Modified product details after date time in UTC."},{"name":"ModifiedBeforeDateTimeUtc","type":"datetime","desc":"Modified product details before date time in UTC."},{"name":"PageNumber","type":"int","desc":"Page number starts with 0."},{"name":"PageSize","type":"int","desc":"Should be between 1000 and 10000."},{"name":"ProductCodes","type":"array_string","desc":"Filter results by a list of Product Codes"},{"name":"ProductSKUs","type":"array_string","desc":"Filter results by a list of SKUs."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getSerialNumbers","method":"post","params":[{"name":"ProductSKU","type":"string","desc":"SKU of the serialized product"},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"}]},{"url":"\/getReceivesHistory","method":"post","params":[{"name":"WarehouseFilter","type":"array_string","desc":"Filter to get receives for one or a list of Warehouse Codes"},{"name":"PageNumber","type":"int","desc":"Specify which page to return. Page number starts with 0."},{"name":"PageSize","type":"int","desc":"Specify page size. Value should be between 1000 and 10000. Default is 10000. We will return the \"Receives\" collection first, then the \"Corrections\" collections last."},{"name":"PoNumberFilter","type":"array_string","desc":"Filter to get receives for one or a list of PO's"},{"name":"ReceivedAfterDateTimeUTC","type":"datetime","desc":"Filter for receives after this date and time."},{"name":"ReceivedBeforeDateTimeUTC","type":"datetime","desc":"Filter for receives before this date and time."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getSaleItemCost","method":"post","params":[{"name":"SaleIds","type":"string","desc":"List of sale IDs. Can be one or multiple."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"}]},{"url":"\/getSales","method":"post","params":[{"name":"Status","type":"string","desc":"One of: ReadyToShip, Pending"},{"name":"OrderIds","type":"array_string","desc":"This is a list of order IDs that you can query for. Max 10000 per call. If you query for orders, we will only return those orders and ignore the \"Status\" filter. Essentially, it overwrites this filter. Also, take note that you can only filter for orders that originated from the API if you send in an Order ID. If you send in the full SkuVault ID, it will return the sale that matches that regardless of its source."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getSalesByDate","method":"post","params":[{"name":"DateField","type":"string","desc":"2 possible values: **Modified** or **Sale**. A value of **Modified** will have the call return sales that have a last modified date within the date range specified. A value of **Sale** will search for sales that have an order date within the specified date range. (Using **Sale** is the how the call works when the DateField parameter isn't included at all)"},{"name":"FromDate","type":"datetime","desc":"Start of inclusive time interval."},{"name":"ToDate","type":"datetime","desc":"End of inclusive time interval."},{"name":"PageNumber","type":"int","desc":"Page number starts with 0."},{"name":"PageSize","type":"int","desc":"Number of sales to return per page. Can be a value between 1000 and 10000. It is 10000 by default."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getShipments","method":"post","params":[{"name":"SaleIds","type":"string","desc":"Sale ID - Must exist in SkuVault"},{"name":"TenantToken","type":"string","desc":"Tenant Token associated with account."},{"name":"UserToken","type":"string","desc":"User Token associated with account."},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getSoldItems","method":"post","params":[{"name":"StartDateUtc","type":"datetime","desc":"Start date in UTC"},{"name":"EndDateUtc","type":"datetime","desc":"End date in UTC"},{"name":"BreakDownKits","type":"boolean","desc":"Break down kits to show component products."},{"name":"PageNumber","type":"int","desc":"Specify page number to be returned.  Page number starts with 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getSuppliers","method":"post","params":[{"name":"PageNumber","type":"int","desc":"10,000 results per page. Defaults to 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/gettokens","method":"post","params":[{"name":"Email","type":"string","desc":"Your SkuVault login email."},{"name":"Password","type":"string","desc":"Your SkuVault login password."},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getTransactions","method":"post","params":[{"name":"FromDate","type":"datetime","desc":""},{"name":"ToDate","type":"datetime","desc":"Max range: 1 week"},{"name":"PageNumber","type":"int","desc":"Page number starts with 0."},{"name":"PageSize","type":"int","desc":"Valid range: 1000-10000"},{"name":"MinimumPageSize","type":"int","desc":"This allows you to set a new minimum page size. Valid Range: 250-999"},{"name":"UserEmail","type":"string","desc":"Include a User's Email to see all transactions made as that user. The email field is case sensitive."},{"name":"WarehouseId","type":"string","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"TransactionType","type":"string","desc":"All, Add, Remove, Pick, or Create"},{"name":"TransactionReasons","type":"array_string","desc":"This is a list of transactions reason to include in the response."},{"name":"ExcludeTransactionReasons","type":"array_string","desc":"This is a list of transactions to exclude from the call"},{"name":"SaleId","type":"string","desc":"Include a sale ID to see all transactions made against a specific sale."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getWarehouseItemQuantities","method":"post","params":[{"name":"ModifiedBeforeDateTimeUtc","type":"datetime","desc":"Modified before date time in UTC (optional, by default used max date)."},{"name":"ModifiedAfterDateTimeUtc","type":"datetime","desc":"Modified after date time in UTC (optional, by default used min date)."},{"name":"PageNumber","type":"int","desc":"Page number with 0 being the first page. Defaults to 0."},{"name":"PageSize","type":"string","desc":"Number of objects to return per page. Can be any value between 1000 and 10000."},{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getWarehouseItemQuantity","method":"post","params":[{"name":"Sku","type":"string","desc":"The Sku to filter by."},{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/getWarehouses","method":"post","params":[{"name":"PageNumber","type":"int","desc":"Page to return. Page number starts with 0."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/pickItem","method":"post","params":[{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"LocationCode","type":"string","desc":"Location Code. Required if not using express pick."},{"name":"Code","type":"string","desc":"Product to pick. Required if not defining SKU."},{"name":"Sku","type":"string","desc":"Product Sku to pick. Required if not defining Code."},{"name":"Quantity","type":"int","desc":"The quantity to pick"},{"name":"IsExpressPick","type":"boolean","desc":"Uses express pick to determine location. Required if not defining location."},{"name":"Note","type":"string","desc":"The note to add to the transaction."},{"name":"ScannedCode","type":"string","desc":"Scanned code"},{"name":"SerialNumbers","type":"array_string","desc":"Serial Numbers. Required for serialized products. Amount of Serial Numbers should correspond to the Quantity."},{"name":"AllowPickItemNotInSale","type":"boolean","desc":"defaults to false, param only required if true"},{"name":"AllowPickQuantityGreaterThanRemainingSaleQuantity","type":"boolean","desc":"defaults to false, param only required if true"},{"name":"PickMode","type":"string","desc":"Can be blank or set to \"Simple\", \"CheckItemAgainstOrder\" or \"QcOnPick\"."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/pickItemBulk","method":"post","params":[{"name":"Items","type":"array_mixed","desc":"The list of items which will be picked within the transaction."},{"name":"Items.Sku","type":"string","desc":"Product Sku to pick. Required if not defining Code."},{"name":"Items.Code","type":"string","desc":"Product to pick. Required if not defining SKU."},{"name":"Items.WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"Items.LocationCode","type":"string","desc":"Location Code. Required if not using express pick."},{"name":"Items.Quantity","type":"int","desc":"The quantity to pick"},{"name":"Items.IsExpressPick","type":"boolean","desc":"Uses Express Pick to determine location. Required if not defining Location Code. Must be entered as either 'false' or 'true'"},{"name":"Items.Note","type":"string","desc":"The note to add to the transaction."},{"name":"Items.SerialNumbers","type":"array_string","desc":"Serial Numbers. Required for serialized products. Amount of Serial Numbers should correspond to the Quantity."},{"name":"Items.PickMode","type":"string","desc":"Can be blank or set to \"Simple\", \"CheckItemAgainstOrder\" or \"QcOnPick\"."},{"name":"Items.AllowPickItemNotInSale","type":"boolean","desc":"defaults to false, param only required if true"},{"name":"Items.AllowPickQuantityGreaterThanRemainingSaleQuantity","type":"boolean","desc":"defaults to false, param only required if true"},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/receivePOItems","method":"post","params":[{"name":"PoNumber","type":"string","desc":"The PO number to receive against."},{"name":"SupplierName","type":"string","desc":"Supplier associated with the PO."},{"name":"ReceiptDate","type":"datetime","desc":"Date and time items were received."},{"name":"LineItems","type":"array_object","desc":""},{"name":"LineItems.SKU","type":"string","desc":"The SKU being received."},{"name":"LineItems.Quantity","type":"int","desc":"The quantity being received."},{"name":"LineItems.QuantityTo3PL","type":"int","desc":"The quantity received being sent to your 3PL warehouse."},{"name":"LineItems.SerialNumbers","type":"array_string","desc":"Serial Numbers. Required for serialized products."},{"name":"LineItems.Location","type":"string","desc":"Location the item quantity is being received to."},{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)* | Required if receiving to a location."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/releaseHeldQuantities","method":"post","params":[{"name":"SkusToRelease","type":"object","desc":"Dictionary of SKUs and the quantity to release for each SKU"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/removeItem","method":"post","params":[{"name":"Code","type":"string","desc":"Product Code. Required if SKU is omitted."},{"name":"Sku","type":"string","desc":"Product SKU. Required if Code is omitted."},{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"LocationCode","type":"string","desc":"The warehouse location to remove quantity from"},{"name":"Quantity","type":"int","desc":"The quantity to remove"},{"name":"Reason","type":"string","desc":"Transaction reason must exist in SkuVault"},{"name":"SerialNumbers","type":"array_string","desc":"Serial Numbers. Required for serialized products. Amount of Serial Numbers should correspond to the Quantity."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/removeItemBulk","method":"post","params":[{"name":"Items","type":"array_object","desc":"Max 100"},{"name":"Items.Code","type":"string","desc":"Product Code. Required if SKU is omitted."},{"name":"Items.Sku","type":"string","desc":"Product SKU. Required if Code is omitted."},{"name":"Items.WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"Items.LocationCode","type":"string","desc":"The warehouse location to remove quantity from"},{"name":"Items.Quantity","type":"int","desc":"The quantity to remove"},{"name":"Items.Reason","type":"string","desc":"Transaction reason must exist in SkuVault"},{"name":"Items.SerialNumbers","type":"array_string","desc":"Serial Numbers. Required for serialized products. Amount of Serial Numbers should correspond to the Quantity."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/setItemQuantities","method":"post","params":[{"name":"Items","type":"array_object","desc":""},{"name":"Items.Code","type":"string","desc":"Required if SKU is omitted."},{"name":"Items.Sku","type":"string","desc":"Required if Code is omitted."},{"name":"Items.WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"Items.LocationCode","type":"string","desc":"The warehouse location to set quantity."},{"name":"Items.Quantity","type":"int","desc":"The quantity to set."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/setItemQuantity","method":"post","params":[{"name":"Code","type":"string","desc":"The SKU you are setting quantity for. Used when SKU is blank."},{"name":"Sku","type":"string","desc":"The SKU you are setting quantity for. Used when Code is blank."},{"name":"WarehouseId","type":"int","desc":"*from [getWarehouses](doc:getwarehouses)*"},{"name":"LocationCode","type":"string","desc":"The warehouse location to set quantity in."},{"name":"Quantity","type":"int","desc":"The quantity to set for a SKU."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/syncOnlineSale","method":"post","params":[{"name":"OrderId","type":"string","desc":"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."},{"name":"MarketplaceId","type":"string","desc":"Add a distinct marketplace ID to your sale."},{"name":"OrderDateUtc","type":"datetime","desc":"The UTC date and time order was created."},{"name":"OrderTotal","type":"double","desc":"Total order price. Can be different than the sum sale price of sold SKUs."},{"name":"CheckoutStatus","type":"string","desc":"[View guide](doc:sale-status-guide). One of: NotVisited, Visited, OnHold, Completed, CompletedOffline, Cancelled"},{"name":"PaymentStatus","type":"string","desc":"[View guide](doc:sale-status-guide). One of: NotSubmitted, Submitted, Deposited, Cleared, Failed"},{"name":"SaleState","type":"string","desc":"[View guide](doc:sale-status-guide). One of: Active, Cancelled, Archived"},{"name":"AutoRemoveInfo","type":"object","desc":"Picks against a sale when sale is marked as \"Completed\"."},{"name":"AutoRemoveInfo.AutoRemove","type":"boolean","desc":"Accepts either \"true\" or \"false\". *Note:* AutoRemove as an account setting is global, so even with a value of \"false\" the system will still attempt to pick sale items."},{"name":"AutoRemoveInfo.WarehouseCode.Code","type":"string","desc":""},{"name":"AutoRemoveInfo.WarehouseName.Name","type":"string","desc":""},{"name":"Notes","type":"string","desc":"Sale notes associated with this order."},{"name":"ItemSkus","type":"array_object","desc":"List of merchant-fulfilled items in the order. Required only if FulfilledItems is missing."},{"name":"ItemSkus.Sku","type":"string","desc":"The SKU sold."},{"name":"ItemSkus.Quantity","type":"int","desc":"The sold quantity, must be higher than or equal to 1."},{"name":"ItemSkus.UnitPrice","type":"double","desc":"The sold unit price."},{"name":"FulfilledItems","type":"array_object","desc":"List of 3PL\/FBA-fulfilled items in the order."},{"name":"FulfilledItems.SKU","type":"string","desc":"The SKU of the sold 3PL line item."},{"name":"FulfilledItems.Quantity","type":"int","desc":"The sold quantity of the 3PL line item."},{"name":"FulfilledItems.UnitPrice","type":"double","desc":"The sold unit price of the 3PL line item."},{"name":"ShippingInfo","type":"object","desc":"Shipping information about sale, such as shipped status, carrier, class, and destination."},{"name":"ShippingInfo.ShippingStatus","type":"string","desc":"[View guide](doc:sale-status-guide). One of: Unshipped, PendingShipment, PartiallyShipped, Shipped"},{"name":"ShippingInfo.ShippingCarrier","type":"string","desc":""},{"name":"ShippingInfo.ShippingClass","type":"string","desc":""},{"name":"ShippingInfo.FirstName","type":"string","desc":""},{"name":"ShippingInfo.LastName","type":"string","desc":""},{"name":"ShippingInfo.CompanyName","type":"string","desc":""},{"name":"ShippingInfo.PhoneNumber","type":"string","desc":""},{"name":"ShippingInfo.Email","type":"string","desc":""},{"name":"ShippingInfo.Line1","type":"string","desc":""},{"name":"ShippingInfo.Line2","type":"string","desc":""},{"name":"ShippingInfo.City","type":"string","desc":""},{"name":"ShippingInfo.Region","type":"string","desc":""},{"name":"ShippingInfo.Postal","type":"string","desc":""},{"name":"ShippingInfo.Country","type":"string","desc":""},{"name":"ChannelType","type":"string","desc":"Channel Type"},{"name":"ChannelAccountId","type":"long","desc":"Channel Account Id"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/syncOnlineSales","method":"post","params":[{"name":"Sales","type":"array_object","desc":"List of sales to sync. **100 sales max**"},{"name":"Sales.MarketplaceId","type":"string","desc":"Add a distinct marketplace ID to your sale."},{"name":"Sales.OrderId","type":"string","desc":"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."},{"name":"Sales.OrderDateUtc","type":"datetime","desc":"The UTC date and time order was created."},{"name":"Sales.OrderTotal","type":"double","desc":"Total order price. Can be different than the sum sale price of sold SKUs."},{"name":"Sales.CheckoutStatus","type":"string","desc":"[View guide](doc:sale-status-guide). One of: NotVisited, Visited, OnHold, Completed, CompletedOffline, Cancelled"},{"name":"Sales.PaymentStatus","type":"string","desc":"[View guide](doc:sale-status-guide). One of: NotSubmitted, Submitted, Deposited, Cleared, Failed"},{"name":"Sales.Notes","type":"string","desc":"Sale notes associated with this order."},{"name":"Sales.SaleState","type":"string","desc":"[View guide](doc:sale-status-guide). One of: Active, Cancelled, Archived"},{"name":"Sales.AutoRemoveInfo","type":"object","desc":"Picks against a sale when sale is marked as \"Completed\"."},{"name":"Sales.AutoRemoveInfo.AutoRemove","type":"boolean","desc":"Accepts either \"true\" or \"false\". *Note:* AutoRemove as an account setting is global, so even with a value of \"false\" the system will still attempt to pick sale items."},{"name":"Sales.AutoRemoveInfo.WarehouseCode.Code","type":"string","desc":""},{"name":"Sales.AutoRemoveInfo.WarehouseName.Name","type":"string","desc":""},{"name":"Sales.ItemSkus","type":"array_object","desc":"List of merchant-fulfilled items in the order. Required only if FulfilledItems is missing."},{"name":"Sales.ItemSkus.Sku","type":"string","desc":"The SKU sold."},{"name":"Sales.ItemSkus.Quantity","type":"int","desc":"The sold quantity."},{"name":"Sales.ItemSkus.UnitPrice","type":"double","desc":"The sold unit price."},{"name":"Sales.FulfilledItems","type":"array_object","desc":"List of 3PL\/FBA-fulfilled items in the order."},{"name":"Sales.FulfilledItems.Sku","type":"string","desc":"The SKU of the sold 3PL\/FBA fulfilled item."},{"name":"Sales.FulfilledItems.Quantity","type":"int","desc":"The quantity of the sold 3PL fulfilled item."},{"name":"Sales.FulfilledItems.UnitPrice","type":"double","desc":"The unit price of the sold 3PL fulfilled item."},{"name":"Sales.ShippingInfo","type":"object","desc":"Shipping information about sale, such as shipped status, carrier, class, and destination."},{"name":"Sales.ShippingInfo.ShippingStatus","type":"string","desc":"[View guide](doc:sale-status-guide). One of: Unshipped, PendingShipment, PartiallyShipped, Shipped"},{"name":"Sales.ShippingInfo.ShippingCarrier","type":"string","desc":""},{"name":"Sales.ShippingInfo.ShippingClass","type":"string","desc":""},{"name":"Sales.ShippingInfo.FirstName","type":"string","desc":""},{"name":"Sales.ShippingInfo.LastName","type":"string","desc":""},{"name":"Sales.ShippingInfo.CompanyName","type":"string","desc":""},{"name":"Sales.ShippingInfo.PhoneNumber","type":"string","desc":""},{"name":"Sales.ShippingInfo.Email","type":"string","desc":""},{"name":"Sales.ShippingInfo.Line1","type":"string","desc":""},{"name":"Sales.ShippingInfo.Line2","type":"string","desc":""},{"name":"Sales.ShippingInfo.City","type":"string","desc":""},{"name":"Sales.ShippingInfo.Region","type":"string","desc":""},{"name":"Sales.ShippingInfo.Postal","type":"string","desc":""},{"name":"Sales.ShippingInfo.Country","type":"string","desc":""},{"name":"ChannelType","type":"string","desc":"Channel Type"},{"name":"ChannelAccountId","type":"long","desc":"Channel Account Id"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/syncShippedSaleAndRemoveItems","method":"post","params":[{"name":"OrderId","type":"string","desc":"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."},{"name":"WarehouseId","type":"int","desc":"The warehouse to Remove quantity from. If not included then the item will be removed from the first location in alphanumerical order across all warehouses."},{"name":"OrderDateUtc","type":"datetime","desc":"The UTC date and time order was created."},{"name":"OrderTotal","type":"double","desc":"Total order price. Can be different than the sum sale price of sold SKUs."},{"name":"Notes","type":"string","desc":"Sale notes associated with this order."},{"name":"ItemSkus","type":"array_object","desc":"List of merchant-fulfilled items in the order. Required only if FulfilledItems is missing."},{"name":"ItemSkus.Sku","type":"string","desc":"The SKU sold."},{"name":"ItemSkus.Quantity","type":"int","desc":"The sold quantity."},{"name":"ItemSkus.UnitPrice","type":"double","desc":"The sold unit price."},{"name":"FulfilledItems","type":"array_object","desc":"List of 3PL-fulfilled items in the order."},{"name":"FulfilledItems.Sku","type":"string","desc":"The SKU sold."},{"name":"FulfilledItems.Quantity","type":"int","desc":"The sold quantity."},{"name":"FulfilledItems.UnitPrice","type":"double","desc":"The sold unit price."},{"name":"ShippingInfo","type":"object","desc":"Shipping information about sale, such as shipped status, carrier, class, and destination."},{"name":"ShippingInfo.ShippingStatus","type":"string","desc":"One of: Unshipped, PendingShipment, PartiallyShipped, Shipped"},{"name":"ShippingInfo.ShippingCarrier","type":"string","desc":""},{"name":"ShippingInfo.ShippingClass","type":"string","desc":""},{"name":"ShippingInfo.FirstName","type":"string","desc":""},{"name":"ShippingInfo.LastName","type":"string","desc":""},{"name":"ShippingInfo.CompanyName","type":"string","desc":""},{"name":"ShippingInfo.PhoneNumber","type":"string","desc":""},{"name":"ShippingInfo.Email","type":"string","desc":""},{"name":"ShippingInfo.Line1","type":"string","desc":""},{"name":"ShippingInfo.Line2","type":"string","desc":""},{"name":"ShippingInfo.City","type":"string","desc":""},{"name":"ShippingInfo.Region","type":"string","desc":""},{"name":"ShippingInfo.Postal","type":"string","desc":""},{"name":"ShippingInfo.Country","type":"string","desc":""},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/syncShippedSaleAndRemoveItems\/bulk","method":"post","params":[{"name":"Sales","type":"array_object","desc":""},{"name":"Sales.OrderId","type":"string","desc":"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."},{"name":"Sales.WarehouseId","type":"int","desc":"The warehouse to Remove ItemSku inventory from."},{"name":"Sales.OrderDateUtc","type":"datetime","desc":"The UTC date and time order was created."},{"name":"Sales.OrderTotal","type":"double","desc":"Total order price. Can be different than the sum sale price of sold SKUs."},{"name":"Sales.Notes","type":"string","desc":"Sale notes associated with this order."},{"name":"Sales.ItemSkus","type":"array_object","desc":"List of merchant-fulfilled items in the order. Required only if FulfilledItems is missing."},{"name":"Sales.ItemSkus.Sku","type":"string","desc":"The SKU sold."},{"name":"Sales.ItemSkus.Quantity","type":"int","desc":"The sold quantity."},{"name":"Sales.ItemSkus.UnitPrice","type":"double","desc":"The sold unit price."},{"name":"Sales.FulfilledItems","type":"array_object","desc":"List of 3PL-fulfilled items in the order. Required if there are no ItemSkus. FulfilledItems inventory will not be deducted in SkuVault."},{"name":"Sales.FulfilledItems.Sku","type":"string","desc":""},{"name":"Sales.FulfilledItems.Quantity","type":"string","desc":""},{"name":"Sales.FulfilledItems.UnitPrice","type":"string","desc":""},{"name":"Sales.ShippingInfo","type":"object","desc":"Shipping information about sale, such as shipped status, carrier, class, and destination."},{"name":"Sales.ShippingInfo.ShippingCarrier","type":"string","desc":""},{"name":"Sales.ShippingInfo.ShippingClass","type":"string","desc":""},{"name":"Sales.ShippingInfo.FirstName","type":"string","desc":""},{"name":"Sales.ShippingInfo.LastName","type":"string","desc":""},{"name":"Sales.ShippingInfo.CompanyName","type":"string","desc":""},{"name":"Sales.ShippingInfo.PhoneNumber","type":"string","desc":""},{"name":"Sales.ShippingInfo.Email","type":"string","desc":""},{"name":"Sales.ShippingInfo.Line1","type":"string","desc":""},{"name":"Sales.ShippingInfo.Line2","type":"string","desc":""},{"name":"Sales.ShippingInfo.City","type":"string","desc":""},{"name":"Sales.ShippingInfo.Region","type":"string","desc":""},{"name":"Sales.ShippingInfo.Postal","type":"string","desc":""},{"name":"Sales.ShippingInfo.Country","type":"string","desc":""},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/updateAltSKUsCodes","method":"post","params":[{"name":"Action","type":"string","desc":"Value can be 'Add', 'Delete', or 'Update'. 'Add' and 'Delete' will only modify a products' Alternates with those specified in the call. 'Update' will overwrite a products' Alternates with the Codes\/SKUs provided."},{"name":"Items","type":"array_object","desc":"Max of 100 items per call."},{"name":"Items.Sku","type":"string","desc":"SKU of the product to update."},{"name":"Items.AltSKUs","type":"array_string","desc":"Alternate SKUs to add, remove, or update the products' Alternates with."},{"name":"Items.AltCodes","type":"array_string","desc":"Alternate Codes to add, remove, or update the products' Alternates with."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/updateExternalWarehouseQuantities","method":"post","params":[{"name":"WarehouseId","type":"string","desc":"*from [getExternalWarehouses](doc:getexternalwarehouses)*"},{"name":"Quantities","type":"array_object","desc":"The array that contains the SKUs and quantities to be updated in the specified warehouse. NOTE: If you wish to update a single SKU, you must send in ALL SKUs in that warehouse. So, if you have 3 SKUs that need to be updated, but you have a total of 100 SKUs in the warehouse, you must send in ALL SKUs and Quantities (in this case all 100 SKUs)"},{"name":"Quantities.SKU","type":"string","desc":"The SKU whose quantities are being updated."},{"name":"Quantities.InStockQuantity","type":"int","desc":"The \"In Stock\" quantity of that SKU. If excluded we will 0 out the quantity."},{"name":"Quantities.InboundQuantity","type":"int","desc":"The \"Inbound\" quantity of that SKU. If excluded we will 0 out the quantity."},{"name":"Quantities.TransferQuantity","type":"int","desc":"The \"Transfer\" quantity of that SKU. If excluded we will 0 out the quantity."},{"name":"Quantities.ReserveQuantity","type":"int","desc":"The \"Reserve\" quantity of that SKU. If excluded we will 0 out the quantity."},{"name":"Quantities.TotalQuantity","type":"int","desc":"The total quantity of that SKU in the external warehouse. We recommend TotalQuantity being the sum of the previous 4 quantities as best practice. If excluded we will 0 out the quantity."},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/updateHandlingTime","method":"post","params":[{"name":"Items","type":"array_object","desc":"List of SKUs to update, max 500 per call."},{"name":"Items.Sku","type":"string","desc":"The SKU you wish to update."},{"name":"Items.Sku.HandlingTime","type":"array_object","desc":"For the given SKU, the accounts and handling times."},{"name":"Items.Sku.HandlingTime.AccountId","type":"string","desc":"The channel account ID acquired from [\/getIntegrations](getintegrations) request"},{"name":"Items.Sku.HandlingTime.Quantity","type":"int","desc":"Between 1 and 30, the number of days it takes to fulfill this SKU."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/updateOnlineSaleStatus","method":"post","params":[{"name":"SaleId","type":"string","desc":"The full SkuVault Sale ID to be updated. NOTE: You can either use SaleID or OrderID. You cannot use both of them."},{"name":"OrderId","type":"string","desc":"The Order ID (not full SkuVault Sale ID) of the order to be updated. NOTE: You can only use this parameter for sales created via the API. If you want to change sale status for sales that did not originate from the API, you must use the 'SaleID' parameter."},{"name":"Status","type":"string","desc":"One of: Pending, ReadyToShip, Completed, Cancelled, Invalid, ShippedUnpaid"},{"name":"TenantToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/updatePOs","method":"post","params":[{"name":"PurchaseOrderId","type":"long","desc":"Purchase Order Id"},{"name":"SupplierName","type":"string","desc":"Supplier Name"},{"name":"LineItems","type":"array_object","desc":"Line Items"},{"name":"LineItems.SKU","type":"string","desc":""},{"name":"LineItems.Quantity","type":"int","desc":""},{"name":"LineItems.QuantityTo3PL","type":"int","desc":""},{"name":"LineItems.Cost","type":"double","desc":""},{"name":"LineItems.PrivateNotes","type":"string","desc":""},{"name":"LineItems.PublicNotes","type":"string","desc":""},{"name":"LineItems.Variant","type":"string","desc":""},{"name":"LineItems.Identifier","type":"string","desc":""},{"name":"Status","type":"string","desc":"Purchase Order Status"},{"name":"PoNumber","type":"string","desc":"PO Number"},{"name":"OrderDate","type":"datetime","desc":"Order Date"},{"name":"OrderCancelDate","type":"datetime","desc":""},{"name":"ArrivalDueDate","type":"datetime","desc":""},{"name":"RequestedShipDate","type":"datetime","desc":""},{"name":"ActualShippedDate","type":"datetime","desc":""},{"name":"TrackingInfo","type":"string","desc":"Tracking Info"},{"name":"PublicNotes","type":"string","desc":"Public Notes"},{"name":"PrivateNotes","type":"string","desc":"Private Notes"},{"name":"TermsName","type":"string","desc":"Terms Name"},{"name":"ShipToWarehouse","type":"string","desc":"Ship to Warehouse"},{"name":"ShipToAddress","type":"string","desc":""},{"name":"ShippingCarrierClass","type":"object","desc":"Shipping Carrier Class"},{"name":"ShippingCarrierClass.CarrierName","type":"string","desc":""},{"name":"ShippingCarrierClass.ClassName","type":"string","desc":""},{"name":"Payments","type":"array_object","desc":""},{"name":"Payments.PaymentName","type":"string","desc":""},{"name":"Payments.Amount","type":"double","desc":""},{"name":"Payments.Note","type":"string","desc":""},{"name":"SentStatus","type":"string","desc":"Sent Status - NotSent, Sent, and NeedToResend (defaults to NotSent)"},{"name":"PaymentStatus","type":"string","desc":"Payment Status - NonePaid, PartiallyPaid, and FullyPaid (defaults to NonePaid)"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]},{"url":"\/updateProduct","method":"post","params":[{"name":"Sku","type":"string","desc":"The SKU you wish to update."},{"name":"Description","type":"string","desc":"Equals \"Title\" inside SkuVault UI."},{"name":"ShortDescription","type":"string","desc":"Limit 1000 characters"},{"name":"LongDescription","type":"string","desc":"Limit 65665 characters."},{"name":"Classification","type":"string","desc":"Must exist in SkuVault."},{"name":"Supplier","type":"string","desc":"Primary Supplier for the product. Additional supplier information will show in the SupplierInfo array."},{"name":"Brand","type":"string","desc":"Must exist in SkuVault."},{"name":"Code","type":"string","desc":"Barcode number."},{"name":"PartNumber","type":"string","desc":"Manufacturer part number."},{"name":"Cost","type":"double","desc":"Accepts decimal; Your overall cost on hand for that product. Used for a default (fallback) cost field or for the cost averaging feature in SkuVault."},{"name":"SalePrice","type":"double","desc":"Accepts decimal; Your selling price per unit"},{"name":"RetailPrice","type":"double","desc":"Accepts decimal; MSRP per unit"},{"name":"Weight","type":"double","desc":"Accepts decimal"},{"name":"WeightUnit","type":"string","desc":"One of: \"lbs\", \"kgs\", \"oz\", \"g\""},{"name":"VariationParentSku","type":"string","desc":""},{"name":"ReorderPoint","type":"int","desc":"The point at which you should reorder quantity."},{"name":"MinimumOrderQuantity","type":"int","desc":""},{"name":"MinimumOrderQuantityInfo","type":"string","desc":""},{"name":"Note","type":"string","desc":"The note to place o the product."},{"name":"Statuses","type":"array_string","desc":"List of statuses on the product."},{"name":"Pictures","type":"array_string","desc":"List of picture urls"},{"name":"Attributes","type":"object","desc":"Dictionary where key is attribute name and value is attribute value. NOTE: If you want to update attributes, please include the Classification value as well."},{"name":"SupplierInfo","type":"array_object","desc":"Array that houses supplier information. This array isn't required, but if you include it, you must specify at least 1 supplier as primary."},{"name":"SupplierInfo.Cost","type":"double","desc":"This is the supplier's cost for that item."},{"name":"SupplierInfo.LeadTime","type":"int","desc":"Supplier's lead time."},{"name":"SupplierInfo.isPrimary","type":"boolean","desc":"At least 1 supplier must be specified as primary (true)."},{"name":"SupplierInfo.SupplierName","type":"string","desc":"The name of your supplier in SkuVault. It must exist in SkuVault and at least one supplier is required."},{"name":"SupplierInfo.SupplierPartNumber","type":"string","desc":"Supplier's part number."},{"name":"SupplierInfo.isActive","type":"boolean","desc":"If a supplier is active, we will use the supplier information (Cost, Supplier Part Number, etc.) when creating a Purchase Order."},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"},{"name":"Client","type":"string","desc":"Only active clients, must exists in UI"}]},{"url":"\/updateProducts","method":"post","params":[{"name":"Items","type":"array_object","desc":"List of products to update. ***100 max.***"},{"name":"Items.Sku","type":"string","desc":"The SKU you wish to update."},{"name":"Items.Description","type":"string","desc":"Equals \"Title\" inside SkuVault UI."},{"name":"Items.ShortDescription","type":"string","desc":"Limit 1000 characters"},{"name":"Items.LongDescription","type":"string","desc":"Limit 65665 characters."},{"name":"Items.Classification","type":"string","desc":"If provided, classification must exist in SkuVault."},{"name":"Items.Supplier","type":"string","desc":"Primary Supplier for the product."},{"name":"Items.Brand","type":"string","desc":"If provided, brand must exist in SkuVault."},{"name":"Items.Code","type":"string","desc":"Barcode number."},{"name":"Items.PartNumber","type":"string","desc":"Manufacturer part number."},{"name":"Items.Cost","type":"double","desc":"Accepts decimal; Your overall cost on hand for that product. Used for a default (fallback) cost field or for the cost averaging feature in SkuVault."},{"name":"Items.SalePrice","type":"double","desc":"Accepts decimal; Your selling price per unit"},{"name":"Items.RetailPrice","type":"double","desc":"Accepts decimal; MSRP per unit"},{"name":"Items.Weight","type":"double","desc":"Accepts decimal"},{"name":"Items.WeightUnit","type":"string","desc":"One of: \"lbs\", \"kgs\", \"oz\", \"g\""},{"name":"Items.VariationParentSku","type":"string","desc":""},{"name":"Items.ReorderPoint","type":"int","desc":"The point at which you should reorder quantity."},{"name":"Items.MinimumOrderQuantity","type":"int","desc":""},{"name":"Items.MinimumOrderQuantityInfo","type":"string","desc":""},{"name":"Items.Note","type":"string","desc":"The note to place o the product."},{"name":"Items.Statuses","type":"array_string","desc":"List of statuses on the product."},{"name":"Items.Pictures","type":"array_string","desc":"List of picture urls"},{"name":"Items.Attributes","type":"object","desc":"Dictionary list where name of attribute is key(AttributeName), value of attribute as value(AttributeValue). NOTE: If you want to update attributes, please include the Classification value as well."},{"name":"Items.SupplierInfo","type":"array_object","desc":"Array that houses supplier information. This array isn't required, but if you include it, you must specify at least 1 supplier as primary."},{"name":"Items.SupplierInfo.SupplierName","type":"string","desc":"The name of your supplier in SkuVault. It must exist in SkuVault and at least one supplier is required."},{"name":"Items.SupplierInfo.SupplierPartNumber","type":"string","desc":"Supplier's part number."},{"name":"Items.SupplierInfo.Cost","type":"double","desc":"This is the supplier's cost for that item."},{"name":"Items.SupplierInfo.LeadTime","type":"int","desc":"Supplier's lead time."},{"name":"Items.SupplierInfo.isActive","type":"boolean","desc":"If true, will use this supplier information when creating a PO."},{"name":"Items.SupplierInfo.isPrimary","type":"boolean","desc":"Must have at least one primary supplier set to *true*"},{"name":"TenantToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"UserToken","type":"string","desc":"*from [getTokens.](doc:gettokens)*"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"},{"name":"Client","type":"string","desc":"Only active clients, must exists in UI"}]},{"url":"\/updateShipments","method":"post","params":[{"name":"Shipments","type":"array_object","desc":"Shipments"},{"name":"SaleIds","type":"string","desc":"List of Sale IDs."},{"name":"Shipments.TrackingNumber","type":"string","desc":"The tracking number associated with the shipment. This parameter cannot be updated."},{"name":"Shipments.Carrier","type":"string","desc":"Shipping company responsible for taking the delivery from Point A to Point B. This parameter cannot be updated."},{"name":"Shipments.Status","type":"string","desc":"The Status of a shipment if a tracking number has been assigned by the carrier."},{"name":"Shipments.LandedCosts","type":"array_object","desc":"Landed Cost is how much of the total cost a line item is responsible for."},{"name":"Shipments.LandedCosts.Sku","type":"string","desc":"Sku associated with Landed cost."},{"name":"Shipments.LandedCosts.Amount","type":"double","desc":"Amount value of Landed Cost. Accepts decimals."},{"name":"Shipments.LandedCosts.CurrencyIsoCode","type":"string","desc":"Type of Currency"},{"name":"TenantToken","type":"string","desc":"Tenant Token to access account"},{"name":"UserToken","type":"string","desc":"User Token"},{"name":"Content-Type","type":"string","desc":"application\/json"},{"name":"Accept","type":"string","desc":"application\/json"}]}]