{
"openapi": "3.0.1",
"info": {
"title": "Orders",
"description": "Provides methods for working with order processing and settings.",
"version": "1.0"
},
"servers": [
{
"url": "https://dsapi.directscale.com/v1/orders"
}
],
"paths": {
"/{orderId}": {
"delete": {
"tags": [
"Orders"
],
"summary": "Cancel Order",
"description": "Cancel the Order based on a valid Order Id.\r\n\r\nYou can get the **Request Parameter** at these calls:\r\n\r\n**orderId**\r\n- Get Order IDs\r\n- Get Order IDs by Filter",
"operationId": "cancel-order",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The Id of the Order to cancel. ",
"required": true,
"schema": {
"type": ""
}
}
],
"responses": {
"200": {
"description": "Order was cancelled."
},
"404": {
"description": "An Order with the given Order Id was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
},
"get": {
"tags": [
"Orders"
],
"summary": "Get Order",
"description": "Retrieves an Order based on a valid Order ID.\r\n\r\nYou can get the **Request Parameter** at these calls:\r\n\r\n**orderId**\r\n- Get Order IDs\r\n- Get Order IDs by Filter\r\n",
"operationId": "594c013e6f6c08a2e90d53c5",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The ID of the Order to retrieve. ",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a valid Order object.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetOrder"
},
"example": {
"OrderInfo": {
"LastModifiedDate": "2019-07-25T02:08:46.0000000+00:00",
"BillPhone": "",
"CommissionDate": "0001-01-01T00:00:00.0000000+00:00",
"DistributorID": 2,
"Email": "amy+sam@directscale.com",
"InvoiceDate": "0001-01-01T00:00:00.0000000+00:00",
"LocalInvoiceNumber": 0,
"Name": "Sam Space",
"OrderDate": "2019-07-25T02:08:41.0000000+00:00",
"OrderType": 1,
"OrderTypeDescription": "Standard",
"OrderNumber": 10003461,
"SpecialInstructions": "",
"Status": "Payment Declined",
"PartyId": 0,
"TotalBonus": 1,
"TotalCost": 0,
"TotalCV": 500,
"TotalRewardPoints": 12,
"TotalQV": 1,
"Void": false,
"BillAddress": {
"Street1": "350 S 400 W",
"Street2": "Ste 225",
"Street3": "",
"City": "Lindon",
"PostalCode": "84042",
"Region": "UT",
"CountryCode": "us"
},
"TaxInfo": null,
"IsPaid": false,
"IsShipped": false,
"LineItems": [
{
"Amount": 1,
"Bonus": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 4,
"Length": 2,
"OrderNumber": 10003461,
"PackageNumber": 1750,
"CV": 500,
"QV": 1,
"RewardPoints": 12,
"Qty": 1,
"SKU": "AAAAA1",
"ItemID": 1,
"ProductName": "Jawa Treats",
"Weight": 1,
"Width": 2,
"FlagCancer": false,
"FlagBirthDefect": false
}
],
"Packages": [
{
"ID": 1750,
"CustomerID": "0",
"Address1": "350 S 400 W",
"Address2": "Ste 225",
"Carrier": "",
"City": "Lindon",
"CountryCode": "us",
"Height": 4,
"Length": 2,
"Notes": "",
"OrderNumber": 10003461,
"ShipByDate": "2019-07-25T02:08:41.0000000+00:00",
"ShipMethodID": 5,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 2,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": null,
"Code": null
}
],
"Totals": [
{
"TaxableSubTotal": 1,
"CurrencyCode": "usd",
"ExchangeRate": 0,
"OrderNumber": 10003461,
"Shipping": 1,
"SubTotal": 1,
"Tax": 0.07,
"TaxTransactionID": "2b3eb458-8055-401e-ac57-bca8bdc82153",
"DiscountTotal": 0,
"OverridenShippingTax": false,
"Total": 2.07,
"PaidAmount": 0,
"TotalDue": 2.07
}
],
"Payments": [
{
"Amount": 2.07,
"AuthorizationNumber": "025318",
"TransactionNumber": "2008e821-14c1-4da6-a222-c63550e5acc8",
"CurrencyCode": "USD",
"ExchangeRate": 1,
"Merchant": 99,
"OrderNumber": 10003461,
"PayDate": "0001-01-01T00:00:00.0000000+00:00",
"PaymentResponse": "F: The transaction has been declined because of an AVS mismatch. The address provided does not match billing address of cardholder.",
"PayType": "Charge",
"Reference": "4242",
"Status": "UnPaid"
}
],
"OrderCustom": {
"Field1": "Fields 1-5",
"Field5": "Here"
}
},
"IsResponseHasError": false,
"Message": ""
}
}
}
},
"404": {
"description": "An Order with the given Order ID was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/autoship/{autoshipId}": {
"delete": {
"tags": [
"Autoships",
"Orders"
],
"summary": "Delete Autoship",
"description": "Deletes an Autoship template based on a valid Autoship ID.
\r\n\r\nYou can get the **Request Parameter** at this call:\r\n\r\n**autoshipId**\r\n- Customers: Get Customer Autoships",
"operationId": "5dd47a42c0ef83bf86c990be",
"parameters": [
{
"name": "autoshipId",
"in": "path",
"description": "ID of the autoship template to be deleted",
"required": true,
"schema": {
"type": "int"
}
}
],
"responses": {
"200": {
"description": "Returns 200 OK."
},
"404": {
"description": "An Order with the given Order ID was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
},
"get": {
"tags": [
"Autoships"
],
"summary": "Get Autoship",
"description": "Retrieves an Autoship based on a valid Autoship ID. An autoship is a template for an order that's executed on a regular basis. This can be used for product, service, or subscription sales orders.
\r\n\r\nYou can get the **Request Parameter** at this call:\r\n\r\n**autoshipId**\r\n- Customers: Get Customer Autoships\r\n",
"operationId": "5dd47906a2933ac2d3380927",
"parameters": [
{
"name": "autoshipId",
"in": "path",
"description": "ID of the autoship to be retrieved",
"required": true,
"schema": {
"type": "int"
}
}
],
"responses": {
"200": {
"description": "Returns a valid Autoship object.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAutoshipResponse"
},
"example": {
"AutoShipID": 1,
"AssociateID": 12,
"AssociateFirstName": "Sam",
"AssociateLastName": "Space",
"ShipAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste. 360",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"StartDate": "2021-10-27T16:19:08.0000000+00:00",
"Frequency": 0,
"LastProcessDate": "2021-10-27T00:00:00.0000000+00:00",
"NextProcessDate": "2021-11-27T00:00:00.0000000+00:00",
"LastChargeAmount": 10,
"Status": "Scheduled",
"ShipMethodDescription": "UPS 3-Day Shipping",
"ShipMethodID": 3,
"PaymentMethodID": "_TESTCARD_E0BNK54A65",
"PaymentDescription": "Visa ending in 4321",
"PaymentExpirationMonth": "10",
"PaymentExpirationYear": "2026",
"PaymentMerchantID": 99,
"AutoShipType": 0,
"LineItems": [
{
"ItemID": 4,
"Quantity": 2,
"Cost": 0,
"ExtendedPrice": 20,
"ExtendedOriginalPrice": 20,
"ExtendedBonus": 0,
"ExtendedCV": 10,
"ExtendedQV": 8,
"ExtendedRewardPoints": 0,
"ExtendedCost": 0,
"ProductName": "SLJ84L",
"Description": "Language description here",
"Specifications": "Specifications here",
"SEO": "",
"LanguageCode": "en",
"SKU": "SLJ84L",
"SkuID": 4,
"Category": {
"ID": 1,
"CategoryTranslations": [
{
"Id": 1,
"CategoryId": 1,
"Description": "Test Category",
"Name": "Test Category",
"LanguageCode": "en"
}
],
"Name": "Test Category",
"Description": "Test Category",
"DisplayIndex": 0,
"ImageUrl": "",
"ParentID": 0,
"ProductLineID": 0,
"ShortDescription": "Test Category",
"StoreIDs": [ ],
"HasChildren": false
},
"ChargeShipping": true,
"Custom": {
"ItemId": 0,
"Field1": "asdf",
"Field2": "1234",
"Field3": "L|M",
"Field4": "1,2,3,4,5",
"Field5": ""
},
"Height": 12,
"Image": "/no_image.jpg",
"Length": 6,
"LengthUOM": "in",
"MPN": "11-22-gg",
"OutOfStockStatus": 1,
"PackCount": 0,
"PackageGroupID": 1,
"TaxClassID": 0,
"UnitOfMeasure": "ea",
"UPC": "Test UPC",
"Weight": 0,
"WeightUOM": "",
"Width": 0,
"FlagBirthDefects": false,
"HasKitGroups": false,
"FlagCancer": true,
"PriceGroup": 1,
"Images": [ ],
"Prices": [
{
"GroupID": 1,
"Price": 10,
"PriceCurrency": "USD",
"OriginalPrice": 10,
"Bonus": 0,
"CV": 5,
"QV": 4,
"RewardPoints": 0
}
],
"Options": [ ],
"ItemOptions": [ ],
"Languages": [
{
"Description": "Language description here",
"LanguageCode": "en",
"ProductName": "SLJ84L",
"SEOKeywords": "",
"Specifications": "Specifications here"
}
],
"OptionsMap": [ ],
"HasOptions": false,
"Price": 10,
"PriceCurrency": "USD",
"OriginalPrice": 10,
"Bonus": 0,
"CV": 5,
"QV": 4,
"RewardPoints": 0,
"CouponsBeingUsed": 0,
"StoreId": 5,
"PriceGroups": [
1
]
}
],
"Custom": {
"Field1": "asdf",
"Field2": "1234",
"Field3": "a,b,c",
"Field4": "122|344",
"Field5": ""
},
"FrequencyString": "Every Week on Wednesday",
"TotalCV": 10,
"TotalQV": 8,
"CurrencyCode": "USD",
"SubTotal": 20
}
}
}
},
"404": {
"description": "An Order with the given Order ID was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/{orderId}/enqueuestats": {
"put": {
"tags": [
"Commissions",
"Orders"
],
"summary": "Enqueue (Trigger) Stats for Order",
"description": "Triggers the statistics engine to calculate user metrics for a particular order, and all upline members impacted by the purchase. It triggers an entire stats rebuild for those impacted by the purchase.\r\n\r\nThis happens automatically for regular purchases (those made using \"Create Customer Order\"). When \"Import External Order\" is used, or another method is used to put an order in the system, for stats to process the order and impact current user metrics, this call can be used.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**orderId**\r\n- Get Order IDs\r\n- Get Order IDs by Filter\r\n- The Order ID is also returned from the Create Customer Order call, and can be input here",
"operationId": "5e7d57d2cbce71ffd7579265",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The OrderId of the order for which you want to set package status shipped.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Package shipping status was successfully updated for all packages in order."
},
"404": {
"description": "The order was not found"
}
}
}
},
"/order-ids": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Order IDs",
"description": "Gets all Order IDs.
\r\n",
"operationId": "5bad1ba78965177b6a0672e4",
"responses": {
"200": {
"description": "Returns an array of Order IDs",
"content": {
"application/json": {
"example": [
1,
2,
3,
4
]
}
}
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/order-ids-by-filter": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Order IDs by Filter",
"description": "Gets all Order IDs that meet the specified criteria.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**orderType**\r\n- Get Order Type(s)\r\n\r\n**orderCreatedBeginDate**\r\n- Get Order\r\n\r\n**Date + Time format**\r\n\r\nYear-Month-Day'T'MilitaryTimeHour:Minute:Second\r\n- Ex. 2020-02-20T15:47:52",
"operationId": "5bad1c9db5cb63c59cc3a49e",
"parameters": [
{
"name": "orderType",
"in": "query",
"schema": {
"type": "int"
}
},
{
"name": "orderCreatedBeginDate",
"in": "query",
"schema": {
"type": "Date/Time"
}
},
{
"name": "orderCreatedEndDate",
"in": "query",
"schema": {
"type": "Date/Time"
}
},
{
"name": "orderUpdatedBeginDate",
"in": "query",
"schema": {
"type": "Date/Time"
}
},
{
"name": "orderUpdatedEndDate",
"in": "query",
"schema": {
"type": "Date/Time"
}
}
],
"responses": {
"200": {
"description": "Returns an array of Order IDs that matched the filter criteria.",
"content": {
"application/json": {
"example": [
1,
3,
10
]
}
}
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/{orderId}/packages/{packageId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Order Package Details",
"description": "Get the details for a package within an order.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**orderId**\r\n- Get Order IDs\r\n- Get Order IDs by Filter\r\n\r\n**packageId**\r\n- Get Order\r\n - Can be found labeled as ``PackagerNumber`` or under the ``Packages`` array at ``ID``.",
"operationId": "59e74311b3ac880abcc07e6d",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The Order number for the given order",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "packageId",
"in": "path",
"description": "The package id for the given package",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns the details of a package.",
"content": {
"application/json": {
"example": {
"Amount": 39.95,
"Bonus": 0,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 5,
"Length": 4,
"OrderNumber": 1234,
"PackageNumber": 5678,
"CV": 10,
"QV": 10,
"Qty": 1,
"SKU": "ABC-1000",
"ItemID": 123,
"ProductName": "First Place Ribbon",
"Weight": 0.5,
"Width": 3,
"FlagCancer": false,
"FlagBirthDefect": false
}
}
}
},
"404": {
"description": "Given order or package was not found."
}
}
}
},
"/{orderId}/rmas": {
"get": {
"tags": [
"rma",
"Orders"
],
"summary": "Get Order RMAs",
"description": "Get RMAs for an order.\r\n\r\nYou can get the **Request Parameter** at these calls:\r\n\r\n**orderId**\r\n- Get Order IDs\r\n- Get Order IDs by Filter",
"operationId": "get-order-rmas",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The ID of the order.",
"required": true,
"schema": {
"type": "int"
}
}
],
"responses": {
"200": {
"description": ""
},
"404": {
"description": "Order not found."
},
"500": {
"description": ""
}
}
}
},
"/order-types/{orderTypeId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Order Type",
"description": "Retrieves an Order Type based on a valid Order Type ID.\r\n\r\nYou can get the **Request Parameter** at this call:\r\n\r\n**orderTypeId**\r\n- Get Order Types",
"operationId": "594c013ea3e348501dc10b86",
"parameters": [
{
"name": "orderTypeId",
"in": "path",
"description": "The ID of the Order Type to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a valid Order Type object.",
"content": {
"application/json": {
"example": {
"ID": 2,
"Description": "AutoShip"
}
}
}
},
"404": {
"description": "An Order Type with the given Order Type ID was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/order-types": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Order Types",
"description": "Retrieves an array of Order Types.
\r\n",
"operationId": "594c013eed38c0285eae4f6a",
"responses": {
"200": {
"description": "Returns an array of valid Order Type objects.",
"content": {
"application/json": {
"example": [
{
"OrderType": 1,
"Description": "Standard"
},
{
"OrderType": 2,
"Description": "AutoShip"
},
{
"OrderType": 3,
"Description": "Enrollment"
}
]
}
}
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/packages/{packageId}": {
"get": {
"tags": [
"Packages"
],
"summary": "Get Package",
"description": "Get Package",
"operationId": "get-package",
"parameters": [
{
"name": "packageId",
"in": "path",
"description": "The ID of the package to retrieve",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The operation was executed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPackage"
},
"example": {
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "us",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50.0000000+00:00",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
}
}
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail."
}
}
}
},
"/packages": {
"get": {
"tags": [
"Packages"
],
"summary": "Get Packages",
"description": "Get Packages",
"operationId": "get-packages",
"parameters": [
{
"name": "warehouseId",
"in": "query",
"description": "The ID of the warehouse from which to retrieve the packages",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "invoiceStartDate",
"in": "query",
"description": "Filters packages whose order's invoice date is the value specified or later. If left out/blank, the default value is today at midnight.",
"schema": {
"type": "date/time string"
}
},
{
"name": "invoiceEndDate",
"in": "query",
"description": "Filters packages whose status is one the value(s) specified. Filters packages whose order's invoice date is the value specified or earlier. If left out/blank, the default value is the current date/time.",
"schema": {
"type": "date/time string"
}
},
{
"name": "packageStatuses",
"in": "query",
"description": "Multiple values must be comma-separated. The default value is \"NotSpecified\", which will return packages of all PackageStatus types.",
"schema": {
"enum": [
"NotSpecified",
"Submitted",
"Printed",
"Shipped",
"RmaInProgress",
"Returned"
],
"type": "PackageStatus[]"
}
}
],
"responses": {
"200": {
"description": "The operation was executed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPackageArray"
},
"example": [
{
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50.0000000+00:00",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
]
}
}
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail."
}
}
}
},
"/price-groups/{priceGroupId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Price Group",
"description": "Retrieves a Price Group based on a valid Price Group ID.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**priceGroupId**\r\n- Get Price Groups",
"operationId": "594c013e663740137535789b",
"parameters": [
{
"name": "priceGroupId",
"in": "path",
"description": "The Id of the Price Group to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a valid Price Group object.",
"content": {
"application/json": {
"example": {
"ID": 2,
"Description": "Retail Associate"
}
}
}
},
"404": {
"description": "A Price Group with the given Price Group ID was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/price-groups": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Price Groups",
"description": "Provides list of available Price Groups.
",
"operationId": "594c013e35d8c872d645cb8b",
"responses": {
"200": {
"description": "Returns an array of valid Price Group objects.",
"content": {
"application/json": {
"example": [
{
"ID": 1,
"Description": "Distributor Associate"
},
{
"ID": 2,
"Description": "Retail Associate"
},
{
"ID": 3,
"Description": "Preferred Customer"
},
{
"ID": 4,
"Description": "100PV Club"
}
]
}
}
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/shipping-methods/{shippingMethodId}": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Shipping Method",
"description": "Retrieves a Shipping Method based on a valid Shipping Method ID.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**shippingMethodId**\r\n- Get Shipping Methods",
"operationId": "594c013e5c6888222836034e",
"parameters": [
{
"name": "shippingMethodId",
"in": "path",
"description": "The ID of the Shipping Method to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a valid Shipping Method object.",
"content": {
"application/json": {
"example": {
"ID": 1,
"Name": "International Shipping",
"CountryCode": "HU",
"Price": 5.25,
"ShipType": 1
}
}
}
},
"404": {
"description": "A Shipping Method with the given Shipping Method ID was not found."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/shipping-methods": {
"get": {
"tags": [
"Orders"
],
"summary": "Get Shipping Methods",
"description": "Retrieves an list of Shipping Methods.
",
"operationId": "594c013e6cf3850afff96220",
"responses": {
"200": {
"description": "Returns an array of valid Shipping Method objects."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/packages/unshipped": {
"get": {
"summary": "Get Unshipped Packages (Deprecated)",
"description": "**DEPRECATED**: Please use the _Get Packages_ operation instead.\r\n\r\nRetrieves list of unshipped packages.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**warehouseId**\r\n- Products: Get Regions",
"operationId": "59e60841b3ac880abcc07e61",
"parameters": [
{
"name": "warehouseId",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns a list of unshipped packages.",
"content": {
"application/json": { }
}
}
}
}
},
"/external-orders": {
"post": {
"tags": [
"Orders"
],
"summary": "Import External Order",
"description": "This API allows clients to import an order that has been processed by a system external to DirectScale. __*This API imports order data for commission calculations only*__. It is therefore assumed that all processing, billing, shipping of goods, etc. for the order was done by the external system.\r\n\r\n#### Order Types\r\n`OrderType` is optional, and will be set to \"Standard\" by default if not passed in as part of the request. If `OrderType` is passed in as part of the request object, please ensure one of the following integers are used:\r\n- Standard - `null`, 0, or 1\r\n- AutoShip - 2\r\n- Enrollment - 3\r\n\r\n#### Duplicate Item/Sku Combinations\r\nIf the request contains multiple line items with the same `ItemId` and `SKU`, these line items will be combined and the quantity will be updated to be the sum of all line item quantities in question.\r\n\r\n#### Mapping External Items to the DirectScale System\r\nA valid order line item must be tied to an external order in order for it to show up in the DirectScale system. For this purpose the request makes both `SKU` and `ItemId` available for mapping. Both, one, or the other may be used to map the given item to an inventory item in the DirectScale inventory system. The logic in the API will attempt to find a match, first using the `ItemId` and then using the `SKU`.\r\n\r\nHowever, sometimes there is no direct mapping. In these situations, a single order line item will be created and applied to the order with the `Import Order Default` Item ID as the `ItemId`. For Example, consider the sample line item request below. Both the `ItemId` and the `SKU` are blank. In this situation, the `Import Order Default` Item ID will be assigned as the the order line item's Item ID.\r\n\r\n```\r\n{\r\n \"ItemId\": 0,\r\n \"Sku\": \"\",\r\n \"ProductName\": \"Sample Product Name\",\r\n \"Quantity\": 1,\r\n \"Price\": 123.45\r\n}\r\n``` ",
"operationId": "import-external-order",
"requestBody": {
"description": "**Required Fields:**\r\n- CustomerId\r\n - Get Customers\r\n - Get Customer by Filter\r\n- ExternalOrderId\r\n - Get Customer\r\n - Get Customer by Parameter\r\n- CommissionDate\r\n - Not sourced by DirectScale\r\n\r\n**Uniqueness Required:**\r\n- ExternalOrderId",
"content": {
"application/json (full)": {
"schema": {
"$ref": "#/components/schemas/ImportOrderRequest"
},
"example": {
"CustomerId": 2,
"OrderType": 1,
"ExternalOrderId": "321123",
"OrderDate": "2020-03-30T00:00:00.0000000+00:00",
"CommissionDate": "2020-03-30T00:00:00.0000000+00:00",
"EmailAddress": "testcust@asdfmail.com",
"InvoiceDate": "2020-03-30T00:00:00.0000000+00:00",
"PartyId": 0,
"PriceGroupId": 1,
"ShippingAddress": {
"Street1": "123 Test Way",
"Street2": "",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"Phone": "123-456-7890",
"SpecialInstructions": "Special Instructions Text",
"CurrencyCode": "usd",
"LineItems": [
{
"ItemId": 11,
"Sku": "",
"ProductName": "Widget",
"Quantity": 2,
"Price": 123.45
},
{
"ItemId": 0,
"Sku": "DEF-456",
"ProductName": "Gadget",
"Quantity": 1,
"Price": 176.55
}
],
"SubTotal": 300,
"ShippingTotal": 5.5,
"TaxTotal": 6.5,
"Total": 311,
"TotalCv": 50,
"TotalQv": 50,
"TotalBonus": 100,
"CustomFields": {
"Field1": "12345",
"Field2": "Some text here",
"Field3": "1|55|33",
"Field4": "Another value",
"Field5": "-22.35"
}
}
},
"application/json (minimal)": {
"example": {
"CustomerId": 2,
"ExternalOrderId": "Jango Fett",
"CommissionDate": "2020-12-25T00:00:00.0000000+00:00",
"SubTotal": 100,
"ShippingTotal": 5,
"TaxTotal": 6,
"Total": 111,
"TotalCv": 5,
"TotalQv": 5,
"TotalBonus": 1000
}
}
}
},
"responses": {
"201": {
"description": "Order successfully imported."
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail."
}
}
}
},
"/insert-payment": {
"post": {
"tags": [
"Orders"
],
"summary": "Insert Payments",
"description": "Inserts a payment into the Payments table.\r\n\r\n**WARNING:** This call does **not** have validation, so as long as the array variables are present, the call will create the desired item, no matter the fields missing.\r\n**NOTE:** Here are the potential ``status`` options:\r\n- Accepted\r\n- Pending\r\n- Redirect\r\n- Rejected\r\n- NotProvided\r\n- PendingPreCheck\r\n- PendingFraudReview\r\n- FraudRejected",
"operationId": "insert-payment",
"requestBody": {
"content": {
"application/json": {
"example": {
"Payments": [
{
"PaymentType": "string",
"AuthorizationCode": "string",
"Response": "string",
"ResponseID": "string",
"TransactionNumber": "string",
"ReferenceNumber": "string",
"Status": "string",
"Amount": 9.42,
"Currency": "usd",
"Merchant": 99,
"FraudPreventionId": "string",
"FraudPreventionProviderId": 0,
"OrderNumber": 10003996,
"Redirect": false,
"RedirectURL": "string",
"SpecialInstructionsURL": "string",
"SavedPaymentId": 0
},
{
"PaymentType": "string",
"AuthorizationCode": "string",
"Response": "string",
"ResponseID": "string",
"TransactionNumber": "string",
"ReferenceNumber": "string",
"Status": "string",
"Amount": 9.42,
"Currency": "usd",
"Merchant": 99,
"FraudPreventionId": "string",
"FraudPreventionProviderId": 0,
"OrderNumber": 10003996,
"Redirect": false,
"RedirectURL": "string",
"SpecialInstructionsURL": "string",
"SavedPaymentId": 0
}
]
}
}
}
},
"responses": {
"201": {
"description": "The Payment was inserted."
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\r\n- Is the model being sent to the API incorrect?\r\n- Did you forget a required field?\r\n- Is the API marked as deprecated, and the date has expired?\r\n\r\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists."
}
}
}
},
"/refund-payment": {
"post": {
"tags": [
"Orders"
],
"summary": "Refund Payment",
"description": "Refund a payment on an order.",
"operationId": "refund-payment",
"requestBody": {
"description": "**Required Fields:**\r\n- OrderNumber\r\n - Get Order\r\n - Get Order Package Details\r\n- Refunds\r\n - PaymentID\r\n - Get Order\r\n - Amount\r\n - Get Order\r\n - Get Order Package Details",
"content": {
"application/json (full)": {
"example": {
"OrderNumber": 10003994,
"Refunds": {
"PaymentID": 304,
"Amount": 35.24,
"ManualRefund": false,
"ManualTransactionID": "string"
}
}
},
"application/json (minimal)": {
"example": {
"OrderNumber": 10003994,
"Refunds": {
"PaymentID": 304,
"Amount": 35.24
}
}
}
}
},
"responses": {
"200": {
"description": "null"
}
}
}
},
"/send-receipt": {
"post": {
"tags": [
"Orders"
],
"summary": "Send Order Receipt",
"description": "Sends an order receipt.",
"operationId": "send-order-receipt",
"requestBody": {
"description": "**Required Fields:**\r\n- orderId\r\n - Get Order\r\n - Get Order Package Details",
"content": {
"application/json": {
"example": {
"orderId": 1234
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/{orderId}/packages/shipped": {
"put": {
"tags": [
"Orders"
],
"summary": "Set Order Shipped (Deprecated)",
"description": "**DEPRECATED**: Please use the _UpdatePackageStatus_ or _UpdatePackageStatusBatch_ operations instead.\r\n\r\nGiven an Order ID, sets the package status to shipped, and updates tracking number and carrier of all packages in an order. \r\n\r\nCarrier and Tracking Number are required fields (see the Request JSON below). The \"Carrier\" field is a loosely-typed indicator used to identify the shipping entity. This can be used in custom code to tie the tracking number to a specific carrier (for generating links, etc.) \r\n\r\nNote: Currently, Disco neither manages nor displays \"Carrier\" anywhere in the base product. It is stored as a non-FK field in table ORD_OrderPackages, and is returned in the \"Get Orders\" API response.\r\n\r\nYou can get the **Request Parameters** at these calls:\r\n\r\n**orderId**\r\n- Get Order IDs\r\n- Get Order IDs by Filter",
"operationId": "set-order-shipped",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The OrderId of the order for which you want to set package status shipped.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "**Required Fields:**\r\n- Carrier\r\n - Not provided by DirectScale\r\n- TrackingNumber\r\n - Not provided by DirectScale",
"content": {
"application/json": {
"example": {
"Carrier": "UPS",
"TrackingNumber": "ABC-123-456"
}
}
}
},
"responses": {
"200": {
"description": "Package shipping status was successfully updated for all packages in order."
},
"404": {
"description": "The order was not found"
}
}
}
},
"/packages/{packageId}/shipped": {
"put": {
"tags": [
"Orders"
],
"summary": "Set Package Shipped (Deprecated)",
"description": "**DEPRECATED**: Please use the _Update Package Status_ or _Update Package Status Batch_ operations instead.\r\n\r\nGiven a Package ID, sets the package status to shipped, and updates tracking number and carrier of the specified package. Note: To update the shipped status and tracking info using an Order Number, see API call \"Set Order Shipped\".\r\n\r\nCarrier and Tracking Number are required fields (see the Request JSON below). The \"Carrier\" field is a loosely-typed indicator used to identify the shipping entity. This can be used in custom code to tie the tracking number to a specific carrier (for generating links, etc.) \r\n\r\nNote: Currently, Disco neither manages nor displays \"Carrier\" anywhere in the base product. It is stored as an open field in table ORD_OrderPackages, and is returned in the \"Get Orders\" API response.\r\n\r\nYou can get the **Request Parameter** at this call:\r\n\r\n**packageId**\r\n- Get Order",
"operationId": "59e6191db3ac880abcc07e62",
"parameters": [
{
"name": "packageId",
"in": "path",
"description": "Package Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The shipping carrier and tracking number.\r\n\r\n**Required Fields:**\r\n- Carrier\r\n - Not provided by DirectScale\r\n- TrackingNumber\r\n - Not provided by DirectScale",
"content": {
"application/json": {
"example": {
"Carrier": "UPS",
"TrackingNumber": "ABC-123-456"
}
}
}
},
"responses": {
"200": {
"description": "Package shipping status was successfully updated."
},
"404": {
"description": "The package was not found."
}
}
}
},
"/packages/split/{packageId}": {
"post": {
"tags": [
"Orders",
"Packages"
],
"summary": "Split Package",
"description": "This API creates additional packages from an already-existing package.\r\n\r\nIt is important to note that **the existing package will not be removed or replaced** as a result of this call. Rather, some of the existing package's line items will be split off and will be assigned to the new packages specified. \r\n\r\n### Example Scenario\r\nLet's say a given package (Package# 222) currently has 4 line items assigned to it with the following item ids: 3, 4, 22, and 19. Additionally, lets suppose that the 3PL working with this API wants to reassign items 4 and 22 to a single new package. This is what the process would look like:\r\n\r\n1. The *existingPackageId* would be specified: *222*\r\n2. The *newPackages* array would contain one entry. This entry, among other specifications, would contain 2 item ids in the *itemIds* parameter: *4* and *22*.\r\n3. The 3PL would then send the request\r\n4. The 3PL receives a response - an array of packages with 2 entries:\r\n - The old package (Package# 222) that now only lists 2 line items associated with it (3 and 19)\r\n - A *new* package (Package# 251) that lists 2 line items associated with it (4 and 22)",
"operationId": "split-package",
"parameters": [
{
"name": "packageId",
"in": "path",
"description": "The ID of the Package to split",
"required": true,
"schema": {
"type": "int"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SplitPackageArray"
},
"example": [
{
"height": 12.5,
"itemIds": [
1,
2
],
"length": 16.75,
"notes": "Deliver to door around back.",
"shipByDate": "2020-11-11T00:00:00.0000000+00:00",
"shipMethodId": 1,
"shippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Suite 225",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"shipToName": "Sam Space",
"warehouseId": 1,
"weight": 1,
"width": 7.25
},
{
"height": 10.75,
"itemIds": [
93
],
"length": 10.75,
"notes": "Deliver to door around back.",
"shipByDate": "2020-11-11T00:00:00.0000000+00:00",
"shipMethodId": 5,
"shippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Suite 225",
"Street3": "",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"shipToName": "Sam Space",
"warehouseId": 2,
"weight": 1,
"width": 7.25
}
]
}
}
},
"responses": {
"201": {
"description": "The operation was executed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPackageArray"
},
"example": [
{
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50.0000000+00:00",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
]
}
}
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail."
}
}
}
},
"/autoships/{autoshipId}": {
"put": {
"tags": [
"Autoships"
],
"summary": "Update Autoship",
"description": "Update Autoship",
"operationId": "update-autoship",
"parameters": [
{
"name": "autoshipId",
"in": "path",
"description": "The ID of the Autoship to update",
"required": true,
"schema": {
"type": "int"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAutoshipRequest"
},
"example": {
"StartDate": "2020-10-08T00:00:00.0000000+00:00",
"Frequency": "Monthly",
"ShipMethodId": 11,
"MerchantId": 99,
"PaymentMethodId": "asdf-1234-qwer-5678",
"ShippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste. 170",
"City": "Testville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"CustomFields": {
"AutoShipId": 123,
"Field1": "Every Month on the 8th",
"Field2": "",
"Field3": "",
"Field4": "",
"Field5": ""
},
"Items": [
{
"ItemId": 1,
"Quantity": 3
}
]
}
}
}
},
"responses": {
"204": {
"description": "The operation was executed successfully"
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail."
}
}
}
},
"/packages/{packageId}/package-status": {
"put": {
"tags": [
"Packages"
],
"summary": "Update Package Status",
"description": "Update Package Status",
"operationId": "update-package-status",
"parameters": [
{
"name": "packageId",
"in": "path",
"description": "The ID of the package to update",
"required": true,
"schema": {
"type": "int"
}
}
],
"requestBody": {
"description": "Currently, the only supported statuses are \"NotSpecified\", \"Printed\", and \"Shipped\". Any attempt to update a package or packages to a different status will result in an error. If the status is set to \"Printed\", the \"printedDate\" parameter will be used to set the Printed Date on the package. If the \"printedDate\" parameter does not contain a value, the current date/time will be used instead. The \"Shipped\" status works in a similar fashion.\r\n\r\nIf no status is provided, the status will default to \"NotSpecified\" and only the carrier info (Carrier and Tracking Number) will be updated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePackageStatusRequest"
},
"example": {
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.8020000+00:00",
"trackingNumber": "asdf-1234-qwer-5678"
}
}
}
},
"responses": {
"204": {
"description": "The operation was executed successfully."
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail."
}
}
}
},
"/packages/batch/package-status": {
"put": {
"tags": [
"Packages",
"Batch"
],
"summary": "Update Package Status Batch",
"description": "Update Package Status Batch",
"operationId": "update-package-status-batch",
"requestBody": {
"description": "Currently, the only supported statuses are \"NotSpecified\", \"Printed\", and \"Shipped\". Any attempt to update a package or packages to a different status will result in an error. If the status is set to \"Printed\", the \"printedDate\" parameter will be used to set the Printed Date on the package. If the \"printedDate\" parameter does not contain a value, the current date/time will be used instead. The \"Shipped\" status works in a similar fashion.\r\n\r\nIf no status is provided, the status will default to \"NotSpecified\" and only the carrier info (Carrier and Tracking Number) will be updated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePackageStatusBatchRequest"
},
"example": [
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.8020000+00:00",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.1070000+00:00",
"shippedDate": "",
"trackingNumber": ""
}
]
}
}
},
"responses": {
"204": {
"description": "The operation was executed successfully."
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description for greater detail.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePackageStatusBatchRequest"
},
"example": [
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.8020000+00:00",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.1070000+00:00",
"shippedDate": "",
"trackingNumber": ""
}
]
}
}
}
}
}
},
"/autoships/frequencies": {
"get": {
"tags": [
"Autoships"
],
"summary": "Get Autoship Frequencies",
"description": "Retrieves an array of supported autoship frequencies.",
"operationId": "get-autoship-frequencies",
"responses": {
"200": {
"description": "The request executed successfully and an array of supported Autoship Frequencies is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoshipFrequencyArray"
},
"example": [
{
"ID": 0,
"Description": "Weekly"
},
{
"ID": 1,
"Description": "Every Two Weeks"
},
{
"ID": 2,
"Description": "Monthly"
},
{
"ID": 3,
"Description": "Bi-Monthly"
},
{
"ID": 4,
"Description": "Tri-Monthly"
},
{
"ID": 6,
"Description": "Yearly"
},
{
"ID": 5,
"Description": "Twice A Year"
},
{
"ID": 7,
"Description": "Every 4 Weeks"
},
{
"ID": 8,
"Description": "Every 6 Weeks"
},
{
"ID": 9,
"Description": "Every 8 Weeks"
},
{
"ID": 10,
"Description": "Every 12 Weeks"
}
]
}
}
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.\n\nFor additional error information and details, please refer to the `x-directscale-message` header.",
"content": {
"application/json": { }
}
}
}
}
},
"/currencies": {
"get": {
"tags": [
"currency"
],
"summary": "Get Currencies",
"description": "Retrieves an array of available currency codes.",
"operationId": "6152301d4cbc9bd214a747fd",
"responses": {
"200": {
"description": "The request executed successfully and an array of supported currencies is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CurrencyArray"
},
"example": [
{
"CurrencyCode": "USD",
"DecimalLength": 2,
"Description": "United States Dollar",
"ExchangeRate": 1,
"Symbol": "$"
},
{
"CurrencyCode": "EUR",
"DecimalLength": 2,
"Description": "European Union Euro",
"ExchangeRate": 0.8,
"Symbol": "€"
},
{
"CurrencyCode": "CAD",
"DecimalLength": 2,
"Description": "Canadian Dollar",
"ExchangeRate": 1.2,
"Symbol": "$"
}
]
}
}
},
"500": {
"description": "Something went wrong... Here are some possible reasons for this error:\n- Is the model being sent to the API incorrect?\n- Did you forget a required field?\n- Is the API marked as deprecated, and the date has expired?\n\nIf the answer is \"No\" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.\n\nFor additional error information and details, please refer to the `x-directscale-message` header.",
"content": {
"application/json": { }
}
}
}
}
},
"/nexio/apple-domain-association-files/{domain}": {
"get": {
"tags": [
"AppleDomainRegistrationFile",
"Nexio",
"Orders",
"APMs"
],
"summary": "Get Nexio Apple Domain Association File",
"description": "Retrieves an Apple Domain Registration File based upon the specified (root) domain. ",
"operationId": "get-nexio-apple-domain-association-file",
"parameters": [
{
"name": "domain",
"in": "path",
"description": "The domain for the Apple Domain Registration File that is to be retrieved",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppleDomainAssociationFileResponse"
},
"example": {
"domain": "some.domain.com",
"fileText": "Sample file text"
}
}
}
},
"400": {
"description": "Returns one of an array of different error possibilities. Please refer to the error description in the `x-directscale-message` header for greater detail."
}
}
}
}
},
"components": {
"schemas": {
"UpdateOrderPackageStatusRequest": {
"type": "object",
"properties": {
"packageStatus": {
"type": "string"
},
"carrier": {
"type": "string"
},
"trackingNumber": {
"type": "string"
}
},
"example": {
"packageStatus": "Shipped",
"carrier": "FedEx",
"trackingNumber": "1a2b3c-4d5e6f-7g8h9i"
}
},
"UpdatePackageStatusRequest": {
"type": "object",
"properties": {
"carrier": {
"type": "string"
},
"packageStatus": {
"type": "string"
},
"printedDate": {
"type": "string"
},
"shippedDate": {
"type": "string"
},
"trackingNumber": {
"type": "string"
}
},
"example": {
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.802Z",
"trackingNumber": "asdf-1234-qwer-5678"
}
},
"UpdatePackageStatusBatchRequest": {
"type": "array",
"items": {
"required": [
"packageId"
],
"type": "object",
"properties": {
"packageId": {
"type": "integer"
},
"carrier": {
"type": "string"
},
"packageStatus": {
"type": "string"
},
"printedDate": {
"type": "string"
},
"shippedDate": {
"type": "string"
},
"trackingNumber": {
"type": "string"
}
}
},
"example": [
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.802Z",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.107Z",
"shippedDate": "",
"trackingNumber": ""
}
]
},
"UpdateOrderPackageStatusBatchRequest": {
"type": "array",
"items": {
"required": [
"orderNumber"
],
"type": "object",
"properties": {
"orderNumber": {
"type": "integer"
},
"packageStatus": {
"type": "string"
},
"carrier": {
"type": "string"
},
"trackingNumber": {
"type": "string"
}
}
},
"example": [
{
"orderNumber": 123,
"packageStatus": "Printed",
"carrier": "FedEx",
"trackingNumber": "1a2b3c-4d5e6f-7g8h9i"
},
{
"orderNumber": 321,
"packageStatus": "Shipped",
"carrier": "UPS",
"trackingNumber": "7g8h9i-4d5e6f-1a2b3c"
}
]
},
"OrderPackage": {
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"CustomerID": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"Carrier": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"Notes": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"ShipByDate": {
"type": "string"
},
"PrintedDate": {
"type": "string"
},
"ShippedDate": {
"type": "string"
},
"ShipMethodID": {
"type": "integer"
},
"State": {
"type": "string"
},
"WarehouseID": {
"type": "integer"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"Zip": {
"type": "string"
},
"ShipTo": {
"type": "string"
},
"Status": {
"type": "string"
},
"TrackingNumber": {
"type": "string"
},
"Code": {
"type": "string"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"OrderLineItemId": {
"type": "integer"
},
"Amount": {
"type": "integer"
},
"Bonus": {
"type": "integer"
},
"CategoryId": {
"type": "integer"
},
"Cost": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PackageNumber": {
"type": "integer"
},
"Cv": {
"type": "integer"
},
"Qv": {
"type": "integer"
},
"Qty": {
"type": "integer"
},
"Sku": {
"type": "string"
},
"ItemId": {
"type": "integer"
},
"ProductName": {
"type": "string"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"FlagCancer": {
"type": "boolean"
},
"FlagBirthDefects": {
"type": "boolean"
},
"HasKitGroups": {
"type": "boolean"
},
"Image": {
"type": "string"
}
}
}
}
},
"example": {
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "us",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50Z",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
},
"SplitPackageArray": {
"type": "array",
"items": {
"required": [
"itemIds",
"shipByDate",
"shipMethodId",
"shippingAddress",
"shipToName",
"warehouseId"
],
"type": "object",
"properties": {
"height": {
"type": "number"
},
"itemIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"length": {
"type": "number"
},
"notes": {
"type": "string"
},
"shipByDate": {
"type": "string"
},
"shipMethodId": {
"type": "integer"
},
"shippingAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"Street3": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"shipToName": {
"type": "string"
},
"warehouseId": {
"type": "integer"
},
"weight": {
"type": "integer"
},
"width": {
"type": "number"
}
}
},
"example": [
{
"height": 12.5,
"itemIds": [
1,
2
],
"length": 16.75,
"notes": "Deliver to door around back.",
"shipByDate": "2020-11-11",
"shipMethodId": 1,
"shippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Suite 225",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"shipToName": "Sam Space",
"warehouseId": 1,
"weight": 1,
"width": 7.25
},
{
"height": 10.75,
"itemIds": [
93
],
"length": 10.75,
"notes": "Deliver to door around back.",
"shipByDate": "2020-11-11",
"shipMethodId": 5,
"shippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Suite 225",
"Street3": "",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"shipToName": "Sam Space",
"warehouseId": 2,
"weight": 1,
"width": 7.25
}
]
},
"UpdateAutoshipRequest": {
"required": [
"StartDate",
"Frequency",
"ShipMethodId",
"MerchantId",
"PaymentMethodId",
"ShippingAddress",
"Items"
],
"type": "object",
"properties": {
"StartDate": {
"type": "string"
},
"Frequency": {
"type": "string"
},
"ShipMethodId": {
"type": "integer"
},
"MerchantId": {
"type": "integer"
},
"PaymentMethodId": {
"type": "string"
},
"ShippingAddress": {
"required": [
"Street1",
"City",
"PostalCode",
"Region",
"CountryCode"
],
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"CustomFields": {
"type": "object",
"properties": {
"AutoShipId": {
"type": "integer"
},
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
},
"Items": {
"type": "array",
"items": {
"required": [
"ItemId",
"Quantity"
],
"type": "object",
"properties": {
"ItemId": {
"type": "integer"
},
"Quantity": {
"type": "integer"
}
}
}
}
},
"example": {
"StartDate": "2020-10-08",
"Frequency": "Monthly",
"ShipMethodId": 11,
"MerchantId": 99,
"PaymentMethodId": "asdf-1234-qwer-5678",
"ShippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste. 170",
"City": "Testville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"CustomFields": {
"AutoShipId": 123,
"Field1": "Every Month on the 8th",
"Field2": "",
"Field3": "",
"Field4": "",
"Field5": ""
},
"Items": [
{
"ItemId": 1,
"Quantity": 3
}
]
}
},
"OrderPackageArray": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"CustomerID": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"Carrier": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"Notes": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"ShipByDate": {
"type": "string"
},
"PrintedDate": {
"type": "string"
},
"ShippedDate": {
"type": "string"
},
"ShipMethodID": {
"type": "integer"
},
"State": {
"type": "string"
},
"WarehouseID": {
"type": "integer"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"Zip": {
"type": "string"
},
"ShipTo": {
"type": "string"
},
"Status": {
"type": "string"
},
"TrackingNumber": {
"type": "string"
},
"Code": {
"type": "string"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"OrderLineItemId": {
"type": "integer"
},
"Amount": {
"type": "integer"
},
"Bonus": {
"type": "integer"
},
"CategoryId": {
"type": "integer"
},
"Cost": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PackageNumber": {
"type": "integer"
},
"Cv": {
"type": "integer"
},
"Qv": {
"type": "integer"
},
"Qty": {
"type": "integer"
},
"Sku": {
"type": "string"
},
"ItemId": {
"type": "integer"
},
"ProductName": {
"type": "string"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"FlagCancer": {
"type": "boolean"
},
"FlagBirthDefects": {
"type": "boolean"
},
"HasKitGroups": {
"type": "boolean"
},
"Image": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50Z",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
]
},
"ImportOrderRequest": {
"required": [
"CustomerId",
"CommissionDate",
"ExternalOrderId"
],
"type": "object",
"properties": {
"CustomerId": {
"type": "integer"
},
"OrderType": {
"type": "integer"
},
"ExternalOrderId": {
"type": "string"
},
"OrderDate": {
"type": "string"
},
"CommissionDate": {
"type": "string"
},
"EmailAddress": {
"type": "string"
},
"InvoiceDate": {
"type": "string"
},
"PartyId": {
"type": "integer"
},
"PriceGroupId": {
"type": "integer"
},
"ShippingAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"Phone": {
"type": "string"
},
"SpecialInstructions": {
"type": "string"
},
"CurrencyCode": {
"type": "string"
},
"LineItems": {
"type": "array",
"items": {
"required": [
"ItemId",
"Sku",
"ProductName",
"Quantity",
"Price"
],
"type": "object",
"properties": {
"ItemId": {
"type": "integer"
},
"Sku": {
"type": "string"
},
"ProductName": {
"type": "string"
},
"Quantity": {
"type": "integer"
},
"Price": {
"type": "number"
}
}
}
},
"SubTotal": {
"type": "integer"
},
"ShippingTotal": {
"type": "number"
},
"TaxTotal": {
"type": "number"
},
"Total": {
"type": "integer"
},
"TotalCv": {
"type": "integer"
},
"TotalQv": {
"type": "integer"
},
"TotalBonus": {
"type": "integer"
},
"CustomFields": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
}
},
"example": {
"CustomerId": 2,
"OrderType": 1,
"ExternalOrderId": "321123",
"OrderDate": "2020-03-30",
"CommissionDate": "2020-03-30",
"EmailAddress": "testcust@asdfmail.com",
"InvoiceDate": "2020-03-30",
"PartyId": 0,
"PriceGroupId": 1,
"ShippingAddress": {
"Street1": "123 Test Way",
"Street2": "",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"Phone": "123-456-7890",
"SpecialInstructions": "Special Instructions Text",
"CurrencyCode": "usd",
"LineItems": [
{
"ItemId": 11,
"Sku": "",
"ProductName": "Widget",
"Quantity": 2,
"Price": 123.45
},
{
"ItemId": 0,
"Sku": "DEF-456",
"ProductName": "Gadget",
"Quantity": 1,
"Price": 176.55
}
],
"SubTotal": 300,
"ShippingTotal": 5.5,
"TaxTotal": 6.5,
"Total": 311,
"TotalCv": 50,
"TotalQv": 50,
"TotalBonus": 100,
"CustomFields": {
"Field1": "12345",
"Field2": "Some text here",
"Field3": "1|55|33",
"Field4": "Another value",
"Field5": "-22.35"
}
}
},
"AutoshipFrequencyArray": {
"type": "array",
"items": {
"required": [
"ID",
"Description",
"DisplayName"
],
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"Description": {
"type": "string"
},
"DisplayName": { }
}
},
"example": [
{
"ID": 0,
"Description": "Weekly"
},
{
"ID": 1,
"Description": "Every Two Weeks"
},
{
"ID": 2,
"Description": "Monthly"
},
{
"ID": 3,
"Description": "Bi-Monthly"
},
{
"ID": 4,
"Description": "Tri-Monthly"
},
{
"ID": 6,
"Description": "Yearly"
},
{
"ID": 5,
"Description": "Twice A Year"
},
{
"ID": 7,
"Description": "Every 4 Weeks"
},
{
"ID": 8,
"Description": "Every 6 Weeks"
},
{
"ID": 9,
"Description": "Every 8 Weeks"
},
{
"ID": 10,
"Description": "Every 12 Weeks"
}
]
},
"CurrencyArray": {
"type": "array",
"items": {
"required": [
"CurrencyCode",
"DecimalLength",
"Description",
"ExchangeRate",
"Symbol"
],
"type": "object",
"properties": {
"CurrencyCode": {
"type": "string"
},
"DecimalLength": {
"type": "integer"
},
"Description": {
"type": "string"
},
"ExchangeRate": {
"type": "integer"
},
"Symbol": {
"type": "string"
}
}
},
"example": [
{
"CurrencyCode": "USD",
"DecimalLength": 2,
"Description": "United States Dollar",
"ExchangeRate": 1,
"Symbol": "$"
},
{
"CurrencyCode": "EUR",
"DecimalLength": 2,
"Description": "European Union Euro",
"ExchangeRate": "0.8",
"Symbol": "€"
},
{
"CurrencyCode": "CAD",
"DecimalLength": 2,
"Description": "Canadian Dollar",
"ExchangeRate": "1.2",
"Symbol": "$"
}
]
},
"GetAutoshipResponse": {
"type": "object",
"properties": {
"AutoShipID": {
"type": "integer"
},
"AssociateID": {
"type": "integer"
},
"AssociateFirstName": {
"type": "string"
},
"AssociateLastName": {
"type": "string"
},
"ShipAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"StartDate": {
"type": "string"
},
"Frequency": {
"type": "integer"
},
"LastProcessDate": {
"type": "string"
},
"NextProcessDate": {
"type": "string"
},
"LastChargeAmount": {
"type": "integer"
},
"Status": {
"type": "string"
},
"ShipMethodDescription": {
"type": "string"
},
"ShipMethodID": {
"type": "integer"
},
"PaymentMethodID": {
"type": "string"
},
"PaymentDescription": {
"type": "string"
},
"PaymentExpirationMonth": {
"type": "string"
},
"PaymentExpirationYear": {
"type": "string"
},
"PaymentMerchantID": {
"type": "integer"
},
"AutoShipType": {
"type": "integer"
},
"LineItems": {
"type": "array",
"items": {
"required": [
"ItemID",
"Quantity",
"Cost",
"ExtendedPrice",
"ExtendedOriginalPrice",
"ExtendedBonus",
"ExtendedCV",
"ExtendedQV",
"ExtendedRewardPoints",
"ExtendedCost",
"ProductName",
"Description",
"Specifications",
"SEO",
"LanguageCode",
"SKU",
"SkuID",
"Category",
"ChargeShipping",
"Custom",
"Height",
"Image",
"Length",
"LengthUOM",
"MPN",
"OutOfStockStatus",
"PackCount",
"PackageGroupID",
"TaxClassID",
"UnitOfMeasure",
"UPC",
"Weight",
"WeightUOM",
"Width",
"FlagBirthDefects",
"HasKitGroups",
"FlagCancer",
"PriceGroup",
"Images",
"Prices",
"Options",
"ItemOptions",
"Languages",
"OptionsMap",
"HasOptions",
"Price",
"PriceCurrency",
"OriginalPrice",
"Bonus",
"CV",
"QV",
"RewardPoints",
"CouponsBeingUsed",
"StoreId",
"PriceGroups"
],
"type": "object",
"properties": {
"ItemID": {
"type": "integer"
},
"Quantity": {
"type": "integer"
},
"Cost": {
"type": "integer"
},
"ExtendedPrice": {
"type": "integer"
},
"ExtendedOriginalPrice": {
"type": "integer"
},
"ExtendedBonus": {
"type": "integer"
},
"ExtendedCV": {
"type": "integer"
},
"ExtendedQV": {
"type": "integer"
},
"ExtendedRewardPoints": {
"type": "integer"
},
"ExtendedCost": {
"type": "integer"
},
"ProductName": {
"type": "string"
},
"Description": {
"type": "string"
},
"Specifications": {
"type": "string"
},
"SEO": {
"type": "string"
},
"LanguageCode": {
"type": "string"
},
"SKU": {
"type": "string"
},
"SkuID": {
"type": "integer"
},
"Category": {
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"CategoryTranslations": {
"type": "array",
"items": {
"required": [
"Id",
"CategoryId",
"Description",
"Name",
"LanguageCode"
],
"type": "object",
"properties": {
"Id": {
"type": "integer"
},
"CategoryId": {
"type": "integer"
},
"Description": {
"type": "string"
},
"Name": {
"type": "string"
},
"LanguageCode": {
"type": "string"
}
}
}
},
"Name": {
"type": "string"
},
"Description": {
"type": "string"
},
"DisplayIndex": {
"type": "integer"
},
"ImageUrl": {
"type": "string"
},
"ParentID": {
"type": "integer"
},
"ProductLineID": {
"type": "integer"
},
"ShortDescription": {
"type": "string"
},
"StoreIDs": {
"type": "array"
},
"HasChildren": {
"type": "boolean"
}
}
},
"ChargeShipping": {
"type": "boolean"
},
"Custom": {
"type": "object",
"properties": {
"ItemId": {
"type": "integer"
},
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
},
"Height": {
"type": "integer"
},
"Image": {
"type": "string"
},
"Length": {
"type": "integer"
},
"LengthUOM": {
"type": "string"
},
"MPN": {
"type": "string"
},
"OutOfStockStatus": {
"type": "integer"
},
"PackCount": {
"type": "integer"
},
"PackageGroupID": {
"type": "integer"
},
"TaxClassID": {
"type": "integer"
},
"UnitOfMeasure": {
"type": "string"
},
"UPC": {
"type": "string"
},
"Weight": {
"type": "integer"
},
"WeightUOM": {
"type": "string"
},
"Width": {
"type": "integer"
},
"FlagBirthDefects": {
"type": "boolean"
},
"HasKitGroups": {
"type": "boolean"
},
"FlagCancer": {
"type": "boolean"
},
"PriceGroup": {
"type": "integer"
},
"Images": {
"type": "array"
},
"Prices": {
"type": "array",
"items": {
"required": [
"GroupID",
"Price",
"PriceCurrency",
"OriginalPrice",
"Bonus",
"CV",
"QV",
"RewardPoints"
],
"type": "object",
"properties": {
"GroupID": {
"type": "integer"
},
"Price": {
"type": "integer"
},
"PriceCurrency": {
"type": "string"
},
"OriginalPrice": {
"type": "integer"
},
"Bonus": {
"type": "integer"
},
"CV": {
"type": "integer"
},
"QV": {
"type": "integer"
},
"RewardPoints": {
"type": "integer"
}
}
}
},
"Options": {
"type": "array"
},
"ItemOptions": {
"type": "array"
},
"Languages": {
"type": "array",
"items": {
"required": [
"Description",
"LanguageCode",
"ProductName",
"SEOKeywords",
"Specifications"
],
"type": "object",
"properties": {
"Description": {
"type": "string"
},
"LanguageCode": {
"type": "string"
},
"ProductName": {
"type": "string"
},
"SEOKeywords": {
"type": "string"
},
"Specifications": {
"type": "string"
}
}
}
},
"OptionsMap": {
"type": "array"
},
"HasOptions": {
"type": "boolean"
},
"Price": {
"type": "integer"
},
"PriceCurrency": {
"type": "string"
},
"OriginalPrice": {
"type": "integer"
},
"Bonus": {
"type": "integer"
},
"CV": {
"type": "integer"
},
"QV": {
"type": "integer"
},
"RewardPoints": {
"type": "integer"
},
"CouponsBeingUsed": {
"type": "integer"
},
"StoreId": {
"type": "integer"
},
"PriceGroups": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
},
"Custom": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
},
"FrequencyString": {
"type": "string"
},
"TotalCV": {
"type": "integer"
},
"TotalQV": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"SubTotal": {
"type": "integer"
}
},
"example": {
"AutoShipID": 1,
"AssociateID": 12,
"AssociateFirstName": "Sam",
"AssociateLastName": "Space",
"ShipAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste. 360",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"StartDate": "2021-10-27T16:19:08",
"Frequency": 0,
"LastProcessDate": "2021-10-27T00:00:00",
"NextProcessDate": "2021-11-27T00:00:00",
"LastChargeAmount": 10,
"Status": "Scheduled",
"ShipMethodDescription": "UPS 3-Day Shipping",
"ShipMethodID": 3,
"PaymentMethodID": "_TESTCARD_E0BNK54A65",
"PaymentDescription": "Visa ending in 4321",
"PaymentExpirationMonth": "10",
"PaymentExpirationYear": "2026",
"PaymentMerchantID": 99,
"AutoShipType": 0,
"LineItems": [
{
"ItemID": 4,
"Quantity": 2,
"Cost": 0,
"ExtendedPrice": 20,
"ExtendedOriginalPrice": 20,
"ExtendedBonus": 0,
"ExtendedCV": 10,
"ExtendedQV": 8,
"ExtendedRewardPoints": 0,
"ExtendedCost": 0,
"ProductName": "SLJ84L",
"Description": "Language description here",
"Specifications": "Specifications here",
"SEO": "",
"LanguageCode": "en",
"SKU": "SLJ84L",
"SkuID": 4,
"Category": {
"ID": 1,
"CategoryTranslations": [
{
"Id": 1,
"CategoryId": 1,
"Description": "Test Category",
"Name": "Test Category",
"LanguageCode": "en"
}
],
"Name": "Test Category",
"Description": "Test Category",
"DisplayIndex": 0,
"ImageUrl": "",
"ParentID": 0,
"ProductLineID": 0,
"ShortDescription": "Test Category",
"StoreIDs": [ ],
"HasChildren": false
},
"ChargeShipping": true,
"Custom": {
"ItemId": 0,
"Field1": "asdf",
"Field2": "1234",
"Field3": "L|M",
"Field4": "1,2,3,4,5",
"Field5": ""
},
"Height": 12,
"Image": "/no_image.jpg",
"Length": 6,
"LengthUOM": "in",
"MPN": "11-22-gg",
"OutOfStockStatus": 1,
"PackCount": 0,
"PackageGroupID": 1,
"TaxClassID": 0,
"UnitOfMeasure": "ea",
"UPC": "Test UPC",
"Weight": 0,
"WeightUOM": "",
"Width": 0,
"FlagBirthDefects": false,
"HasKitGroups": false,
"FlagCancer": true,
"PriceGroup": 1,
"Images": [ ],
"Prices": [
{
"GroupID": 1,
"Price": 10,
"PriceCurrency": "USD",
"OriginalPrice": 10,
"Bonus": 0,
"CV": 5,
"QV": 4,
"RewardPoints": 0
}
],
"Options": [ ],
"ItemOptions": [ ],
"Languages": [
{
"Description": "Language description here",
"LanguageCode": "en",
"ProductName": "SLJ84L",
"SEOKeywords": "",
"Specifications": "Specifications here"
}
],
"OptionsMap": [ ],
"HasOptions": false,
"Price": 10,
"PriceCurrency": "USD",
"OriginalPrice": 10,
"Bonus": 0,
"CV": 5,
"QV": 4,
"RewardPoints": 0,
"CouponsBeingUsed": 0,
"StoreId": 5,
"PriceGroups": [
1
]
}
],
"Custom": {
"Field1": "asdf",
"Field2": "1234",
"Field3": "a,b,c",
"Field4": "122|344",
"Field5": ""
},
"FrequencyString": "Every Week on Wednesday",
"TotalCV": 10,
"TotalQV": 8,
"CurrencyCode": "USD",
"SubTotal": 20
}
},
"GetOrder": {
"type": "object",
"properties": {
"OrderInfo": {
"type": "object",
"properties": {
"LastModifiedDate": {
"type": "string"
},
"BillPhone": {
"type": "string"
},
"CommissionDate": {
"type": "string"
},
"DistributorID": {
"type": "integer"
},
"Email": {
"type": "string"
},
"InvoiceDate": {
"type": "string"
},
"LocalInvoiceNumber": {
"type": "integer"
},
"Name": {
"type": "string"
},
"OrderDate": {
"type": "string"
},
"OrderType": {
"type": "integer"
},
"OrderTypeDescription": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"SpecialInstructions": {
"type": "string"
},
"Status": {
"type": "string"
},
"PartyId": {
"type": "integer"
},
"TotalBonus": {
"type": "integer"
},
"TotalCost": {
"type": "integer"
},
"TotalCV": {
"type": "integer"
},
"TotalRewardPoints": {
"type": "integer"
},
"TotalQV": {
"type": "integer"
},
"Void": {
"type": "boolean"
},
"BillAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"Street3": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"TaxInfo": { },
"IsPaid": {
"type": "boolean"
},
"IsShipped": {
"type": "boolean"
},
"LineItems": {
"type": "array",
"items": {
"required": [
"Amount",
"Bonus",
"Cost",
"CurrencyCode",
"Height",
"Length",
"OrderNumber",
"PackageNumber",
"CV",
"QV",
"RewardPoints",
"Qty",
"SKU",
"ItemID",
"ProductName",
"Weight",
"Width",
"FlagCancer",
"FlagBirthDefect"
],
"type": "object",
"properties": {
"Amount": {
"type": "integer"
},
"Bonus": {
"type": "integer"
},
"Cost": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PackageNumber": {
"type": "integer"
},
"CV": {
"type": "integer"
},
"QV": {
"type": "integer"
},
"RewardPoints": {
"type": "integer"
},
"Qty": {
"type": "integer"
},
"SKU": {
"type": "string"
},
"ItemID": {
"type": "integer"
},
"ProductName": {
"type": "string"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"FlagCancer": {
"type": "boolean"
},
"FlagBirthDefect": {
"type": "boolean"
}
}
}
},
"Packages": {
"type": "array",
"items": {
"required": [
"ID",
"CustomerID",
"Address1",
"Address2",
"Carrier",
"City",
"CountryCode",
"Height",
"Length",
"Notes",
"OrderNumber",
"ShipByDate",
"ShipMethodID",
"State",
"WarehouseID",
"Weight",
"Width",
"Zip",
"ShipTo",
"Status",
"TrackingNumber",
"Code"
],
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"CustomerID": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"Carrier": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"Notes": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"ShipByDate": {
"type": "string"
},
"ShipMethodID": {
"type": "integer"
},
"State": {
"type": "string"
},
"WarehouseID": {
"type": "integer"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"Zip": {
"type": "string"
},
"ShipTo": {
"type": "string"
},
"Status": {
"type": "string"
},
"TrackingNumber": { },
"Code": { }
}
}
},
"Totals": {
"type": "array",
"items": {
"required": [
"TaxableSubTotal",
"CurrencyCode",
"ExchangeRate",
"OrderNumber",
"Shipping",
"SubTotal",
"Tax",
"TaxTransactionID",
"DiscountTotal",
"OverridenShippingTax",
"Total",
"PaidAmount",
"TotalDue"
],
"type": "object",
"properties": {
"TaxableSubTotal": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"ExchangeRate": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"Shipping": {
"type": "integer"
},
"SubTotal": {
"type": "integer"
},
"Tax": {
"type": "number"
},
"TaxTransactionID": {
"type": "string"
},
"DiscountTotal": {
"type": "integer"
},
"OverridenShippingTax": {
"type": "boolean"
},
"Total": {
"type": "number"
},
"PaidAmount": {
"type": "integer"
},
"TotalDue": {
"type": "number"
}
}
}
},
"Payments": {
"type": "array",
"items": {
"required": [
"Amount",
"AuthorizationNumber",
"TransactionNumber",
"CurrencyCode",
"ExchangeRate",
"Merchant",
"OrderNumber",
"PayDate",
"PaymentResponse",
"PayType",
"Reference",
"Status"
],
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"AuthorizationNumber": {
"type": "string"
},
"TransactionNumber": {
"type": "string"
},
"CurrencyCode": {
"type": "string"
},
"ExchangeRate": {
"type": "integer"
},
"Merchant": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PayDate": {
"type": "string"
},
"PaymentResponse": {
"type": "string"
},
"PayType": {
"type": "string"
},
"Reference": {
"type": "string"
},
"Status": {
"type": "string"
}
}
}
},
"OrderCustom": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
}
}
},
"IsResponseHasError": {
"type": "boolean"
},
"Message": {
"type": "string"
}
},
"example": {
"OrderInfo": {
"LastModifiedDate": "2019-07-25T02:08:46Z",
"BillPhone": "",
"CommissionDate": "0001-01-01T00:00:00Z",
"DistributorID": 2,
"Email": "amy+sam@directscale.com",
"InvoiceDate": "0001-01-01T00:00:00Z",
"LocalInvoiceNumber": 0,
"Name": "Sam Space",
"OrderDate": "2019-07-25T02:08:41Z",
"OrderType": 1,
"OrderTypeDescription": "Standard",
"OrderNumber": 10003461,
"SpecialInstructions": "",
"Status": "Payment Declined",
"PartyId": 0,
"TotalBonus": 1,
"TotalCost": 0,
"TotalCV": 500,
"TotalRewardPoints": 12,
"TotalQV": 1,
"Void": false,
"BillAddress": {
"Street1": "350 S 400 W",
"Street2": "Ste 225",
"Street3": "",
"City": "Lindon",
"PostalCode": "84042",
"Region": "UT",
"CountryCode": "us"
},
"TaxInfo": null,
"IsPaid": false,
"IsShipped": false,
"LineItems": [
{
"Amount": 1,
"Bonus": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 4,
"Length": 2,
"OrderNumber": 10003461,
"PackageNumber": 1750,
"CV": 500,
"QV": 1,
"RewardPoints": 12,
"Qty": 1,
"SKU": "AAAAA1",
"ItemID": 1,
"ProductName": "Jawa Treats",
"Weight": 1,
"Width": 2,
"FlagCancer": false,
"FlagBirthDefect": false
}
],
"Packages": [
{
"ID": 1750,
"CustomerID": "2",
"Address1": "350 S 400 W",
"Address2": "Ste 225",
"Carrier": "",
"City": "Lindon",
"CountryCode": "us",
"Height": 4,
"Length": 2,
"Notes": "",
"OrderNumber": 10003461,
"ShipByDate": "2019-07-25T02:08:41Z",
"ShipMethodID": 5,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 2,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": null,
"Code": null
}
],
"Totals": [
{
"TaxableSubTotal": 1,
"CurrencyCode": "usd",
"ExchangeRate": 0,
"OrderNumber": 10003461,
"Shipping": 1,
"SubTotal": 1,
"Tax": 0.07,
"TaxTransactionID": "2b3eb458-8055-401e-ac57-bca8bdc82153",
"DiscountTotal": 0,
"OverridenShippingTax": false,
"Total": 2.07,
"PaidAmount": 0,
"TotalDue": 2.07
}
],
"Payments": [
{
"Amount": 2.07,
"AuthorizationNumber": "025318",
"TransactionNumber": "2008e821-14c1-4da6-a222-c63550e5acc8",
"CurrencyCode": "USD",
"ExchangeRate": 1,
"Merchant": 99,
"OrderNumber": 10003461,
"PayDate": "0001-01-01T00:00:00Z",
"PaymentResponse": "F: The transaction has been declined because of an AVS mismatch. The address provided does not match billing address of cardholder.",
"PayType": "Charge",
"Reference": "4242",
"Status": "UnPaid"
}
],
"OrderCustom": {
"Field1": "Fields 1-5",
"Field5": "Here"
}
},
"IsResponseHasError": false,
"Message": ""
}
},
"AppleDomainAssociationFileResponse": {
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"fileText": {
"type": "string"
}
},
"example": {
"domain": "some.domain.com",
"fileText": "Sample file text"
}
}
},
"securitySchemes": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "subscription-key",
"in": "query"
}
}
},
"security": [
{
"apiKeyHeader": [ ]
},
{
"apiKeyQuery": [ ]
}
]
}