Getting Started

Overview

This is an introduction to our APIs. On this page, you can see the basic operations you can do with the APIs we offer, the minimum parameters required to use them, and code examples.

It's important to note that the parameters and code examples shown in these tables are the minimum needed to send the API request. There are additional parameters that can be added. For more information on these parameters, visit the API endpoint directly.

Click below to go directly to the API you're looking for:

Addresses API

Endpoint

Required Parameters

Code Example

Create/Update a Customer's Address

  • InternalCustomerID

  • ExternalCustomerID

  • UserID

    Note: You can only enter one of these for each API request.

PUT https://api.qa1.orderdynamics.net/v1/addresses/Customers?AddressType=Billing&IsDefaultShippingAddress=false&InternalCustomerId=88&ExternalCustomerId=122&UserId=122 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] 
{ 
  "AddressLine1": "123 Bloor St", 
  "AddressLine2": "Apt 1", 
  "AddressLine3": "Block A", 
  "City": "Toronto", 
  "State": "ON", 
  "ZipCode": "L4K1L6", 
  "CountryCode": "CA", 
  "AddressNickname": "Home", 
  "FirstName": "Jane", 
  "LastName": "Smith", 
  "CompanyName": "Tecsys", 
  "Latitude": 0, 
  "Longitude": 0, 
  "ExternalAddressId": "", 
}

Get List of Countries User Has Enabled

There are no required parameters. You can send the request and get a list of all counties enabled or enter a language code to get a specific country with that language.

GET https://api.qa1.orderdynamics.net/v1/addresses/Countries 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get List of States/Provinces

  • CountryCode - This is the two digit country code. For example. Canada = 'CA'

GET https://api.qa1.orderdynamics.net/v1/addresses/Provinces?CountryCode=CA 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Update an Address

  • InternalAddressID

  • ExternalAddressID

PUT https://api.qa1.orderdynamics.net/v1/addresses/?InternalAddressId=88
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] 
{ 
  "AddressLine1": "123 Bloor St", 
  "AddressLine2": "Apt 1", 
  "AddressLine3": "Block A", 
  "City": "Toronto", 
  "State": "ON", 
  "ZipCode": "L4K1L6", 
  "CountryCode": "CA", 
  "AddressNickname": "Home", 
  "FirstName": "Jane", 
  "LastName": "Smith", 
  "CompanyName": "Tecsys", 
  "Latitude": 0, 
  "Longitude": 0, 
  "ExternalAddressId": "", 
}

Allocation Strategies API

Endpoint

Required Parameters

Code Example

Get Allocation Strategy by ID

  • InternalOrderID

  • ExternalOrderID

    Note: You can only enter one of these for each API request.

curl -request -X GET "https://api.qa1.orderdynamics.net /AllocationStrategies/v1?OwnerType=Order&InternalOrderId=88" 
--header "Content-Type: application/json" --header "Ocp-Apim-Subscription-Key: [YOUR_API_KEY]"

Bulk Status API

Endpoint

Required Parameters

Code Example

Get Bulk Job Details

  • DateSubmittedUTC

  • JobId

GET https://api.qa1.orderdynamics.net/v1/StatusManagement/88?DateSubmittedUTC=2023-05-01&PageSize=100&pageNumber=1&JobStatus=Failed
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Configurations API

Endpoint

Required Parameters

Code Example

Get All Parameter Settings

There are no required parameters. You can send the request and get a list of parameters.

GET https://api.qa1.orderdynamics.net/configurations/Parameters/v1
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Custom Field MetaData API

Endpoint

Required Parameters

Code Example

Get a List of Custom Fields Meta Data by Owner Type

  • ownerType

GET https://api.qa1.orderdynamics.net/v1/customfieldmetadata/invoices
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get Custom Field Meta Data for Specific Custom Fields

  • OwnerType

  • SystemNames

GET https://api.qa1.orderdynamics.net/v1/customfieldmetadata/?OwnerType=invoices&SystemNames=apim_booleaninvoices
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Customers API

Endpoint

Required Parameters

Code Example

Create a Customer

  • Email

  • ExternalCustomerId

  • UserId
    Note: You can only enter one of these for each API request.

POST https://api.qa1.orderdynamics.net/v1/customers/
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "Title": "", 
  "FirstName": "Jane", 
  "LastName": "Smith", 
  "Email": "jane.smith@tecsys.com", 
  "SubscriberOptIn": true, 
  "CompanyName": "Tecsys", 
  "PhoneNumber": "123-456-7890", 
  "Password": "Hello123$", 
  "CustomerLevel": 0,
  "AccountLocked": true, 
   "Sex": "F", 
   "BirthYear": "1993", 
   "Language": "en-US", 
   "TimeZoneId": "Eastern Standard Time",
   "UserId": "jane.smith@tecsys.com"            
 }

Get Customers

  • There are no required parameters. You can send the request and get a list of all customers.

GET https://api.qa1.orderdynamics.net/v1/customers/
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Search Customers

  • SearchKeyword
    Note: You can enter the first or last three letters of the customer's first name, last name or email.

GET https://api.qa1.orderdynamics.net/v1/customers/Search?SearchKeyword=des&SortByColumn=Id
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Update a Customer

  • InternalCustomerId

  • ExternalCustomerId

  • UserId
    Note: You can only enter one of these for each API request.

PUT https://api.qa1.orderdynamics.net/v1/customers/
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "Title": "", 
  "FirstName": "Jane", 
  "LastName": "Smith", 
  "Email": "jane.smith@tecsys.com", 
  "SubscriberOptIn": true, 
  "CompanyName": "Tecsys", 
  "PhoneNumber": "123-456-7890", 
  "Password": "Hello123$", 
  "CustomerLevel": 0,
  "AccountLocked": true, 
   "Sex": "F", 
   "BirthYear": "1993", 
   "Language": "en-US", 
   "TimeZoneId": "Eastern Standard Time",
   "UserId": "jane.smith@tecsys.com"            
 }

Emails API

Endpoint

Required Parameters

Code Examples

Get Email Logs for Customer by Internal Customer ID

  • InternalCustomerId

GET https://api.qa1.orderdynamics.net/v1/emails/?InternalCustomerId=88&SortByColumn=Id
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Resend an Email

  • StorageId

POST https://api.qa1.orderdynamics.net/v1/emails/ResendEmails 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "StorageId": "cases" 
}

Images API

Endpoint

Required Parameters

Code Examples

Create Images For Entities

  • OwnerName

  • OwnerID

  • PublicDescription

  • ImageUrl

  • Culture

POST https://api.qa1.orderdynamics.net/v1/images/ 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] [{ 
  "OwnerName": "Products", 
  "OwnerID": "MyProduct", 
  "PublicDescription": "English Image", "ImageUrl": "http://myimage.google.ca/myProductImage.png", 
   "Culture": "en-US" 
}]

Delete all Images Associated with Owner ID

  • OwnerID

DELETE https://api.qa1.orderdynamics.net/v1/images/?OwnerName=Products&OwnerID=123  Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Inventory Locations API

Endpoint

Required Parameters

Code Examples

Create an Inventory Location

  • InternalName
    Note: The InternalName must be unique

POST https://api.qa1.orderdynamics.net/v1/inventorylocations/ 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY] { 
  "InternalName": "Toronto South", 
  "PublicName": "Bloor East", 
  "RouteType": "ShippingCenter", 
  "RouteDestination": "Richmond Hill_SC",
  "UseInEcommerceStockCalculation":true,
  "IncludeFutureInventoryFromDays": 7, 
  "IsDistributionCenter": true, 
  "WavePackTime": 4, 
  "Address": { 
     "AddressLine1": "7 Bloor St. East",
     "AddressLine2": "Unit 12" , 
     "AddressLine3": "Block A", 
     "City": "Toronto", 
     "State": "ON", "ZipCode": 
     "M4W 3H1", 
     "CountryCode": "CA" 
}]

Get Inventory Locations

  • There are no required parameters. You can send the request and get a list of all inventory locations.

POST https://api.qa1.orderdynamics.net/v1/inventorylocations/?pageSize=100&pageNumber=1
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Update an Inventory Location

  • locationInternalName

PUT https://api.qa1.orderdynamics.net/v1/inventorylocations/?locationInternalName=Toronto_South 
Content-Type: application/json 
Cache-Control: no-cache Ocp-Apim-Subscription-Key: [YOUR_API_KEY] 
{ 
  "InternalName": "Toronto South", 
  "PublicName": "Bloor East", 
  "RouteType": "ShippingCenter", 
  "RouteDestination": "Richmond Hill",
  "IsDistributionCenter": true, 
  "WavePackTime": 4, 
  "Address": { 
    "AddressLine1": "7 Bloor St. East",
    "AddressLine2": "Unit 12",  
    "AddressLine3": "Block A", 
    "City": "Toronto", 
    "State": "ON", 
    "ZipCode": "M4W 3H1",  
    "CountryCode": "CA" 
}, 
"FeederLocations": ["Toronto West", "Toronto East"]
}

Delete an Inventory Location

  • locationInternalName

DELETE https://api.qa1.orderdynamics.net/v1/inventorylocations/?locationInternalName=Toronto_South 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Items API

Endpoints

Required Parameters

Code Examples

Create an Item

  • PrimaryItemName

  • LocalizeItemName

  • DefaultCulture

  • Sku

  • CustomAttributes

  • Upc

  • ISBN

  • ASIN

  • Warehouse

  • AddToBasePrice

  • AddToShippingCost

  • AddToBaseWeight

  • MinPurchaseAmount

  • MaxPurchaseAmount

  • WholesalePrice

  • UnitOfMeasure

  • TargetQuantity

  • ReOrderThreshold

  • InitialInventory

  • InventoryLocation

  • OutOfStockBehaviour

  • ProductBackendName

  • PreOrderItem

  • SendEmailNotification

  • DisableInventoryControl

POST https://api.qa1.orderdynamics.net/v1/items/?BindAllAttributes=false 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "Upc": "UPC_Value", 
  "ISBN": "ISBN_Value", 
  "Mpn": "MPN_Value", 
  "ASIN": "ASIN_Value", 
  "Warehouse": "Brampton Warehouse", 
  "AddToBasePrice": 1, 
  "AddToShippingCost": 1, 
  "AddToBaseWeight": 1, 
  "MinPurchaseAmount": 1, 
  "MaxPurchaseAmount": 1, 
  "WholesalePrice": 100, 
  "UnitOfMeasure": "Kilograms", 
  "TargetQuantity": 100, 
  "OutOfStockThreshold": 20, 
  "ReOrderThreshold": 25, 
  "InitialInventory": 100, 
  "InventoryLocation": "Toronto", 
  "OutOfStockBehavior": "AllowOrdering",
  "ProductBackendName": "Product 123456",
  "PreOrderItem": false, 
  "SendEmailNotification": false, 
  "DisableInventoryControl": false, 
  "PrimaryItemName": "Large Shirt", 
  "Sku": "Large_Shirt_Red", 
  "DefaultCulture": "en-US", 
  "LocalizedItemName": [{ 
     "Culture": "en-CA",
     "value": "Large Shirt" 
 }], 
  "CustomAttributes": [{ 
     "AttributeGroupName": "eBay", 
     "AttributeName": "Features", 
     "Value": "Feature 1" }] 
}

Delete an Item

  • SKU

DELETE https://api.qa1.orderdynamics.net/v1/items/?Sku=Large_Red_Shirt 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get Items

  • ProductBackendName

  • SKU
    Note: You can supply either one of these or both.

GET https://api.qa1.orderdynamics.net/v1/items/?LoadAttributes=false&LoadCategories=false&LoadInventory=false&LoadLocalizationData=false&Sku=Large_Red_Shirt&pageSize=100&pageNumber=1 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get SKUs

  • There are no required parameters. You can send the request and get a list of SKUs.

GET https://api.qa1.orderdynamics.net/v1/items/Skus?PageSize=100&PageNumber=1  
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get an Item Site Pricing

  • SKU

GET https://api.qa1.orderdynamics.net/v1/items/SitePricing?Sku=123457843635576&SortByColumn=Channel  
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Logging API

Endpoint

Required Parameters

Code Examples

Get Flexible events by Event Initiator ID and Owner ID

  • OwnerID

  • EventInitiatorID

GET https://api.qa1.orderdynamics.net/v1/logging/FlexibleEvents?EventInitiatorType=OrderSave&OwnerId=88 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Notes API

Endpoint

Required Parameters

Code Examples

Create a Note

  • Key

  • Text

  • CreatedBy

  • Type

  • TableName

  • IsSystem

POST https://api.qa1.orderdynamics.net/v1/notes/ 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY] { 
  "Key": 1, 
  "Text": "SampleNote", 
  "CreatedBy": "SampleUser", 
  "Type": "Note", 
  "TableName": "Customers", 
  "IsSystem": false 
}

Get Note Attachment

  • AttachmentId

GET https://api.qa1.orderdynamics.net/v1/notes/Attachment?AttachmentId=4215 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get Notes

  • There are no required parameters. You can send the request and get a list of notes.

GET https://api.qa1.orderdynamics.net/v1/notes/?TableName=Invoices&SortByColumn=NoteId 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Order Fulfillment API

Endpoint

Required Parameters

Code Examples

Cancel a Shipment

  • ShipmentId

POST https://api.qa1.orderdynamics.net/v1/orderfulfillment/shipments/Cancel?ShipmentId=1842 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Create All Shipments

  • InternalOrderID

  • ExternalOrderID
    Note: You can only enter one of these for each API request.

POST https://api.qa1.orderdynamics.net/v1/orderfulfillment/shipments/CreateAllShipments 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "InternalOrderId": 486124, 
  "ExternalOrderId": "" 
}

Get Shipments

  • There are no required parameters. You can send the request and get a list of shipments.

GET https://api.qa1.orderdynamics.net/v1/orderfulfillment/shipments/?pageSize=100&pageNumber=1 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Order Orchestration API

Endpoint

Required Parameters

Code Examples

Cancel an Order

  • internalOrderId

  • externalOrderId
    Note: You must supply either the Internal Order ID or the External Order ID but not both.

  • cancelReason

POST https://api.qa1.orderdynamics.net/v1/orders/Cancel?internalOrderId=416425&cancelReason=broken 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Create an Order

  • Channel

  • CurrencyCode

  • ExternalOrderId

  • BillingCustomer

  • BillingAddress

  • ShippingAddress

  • LineItems

POST https://api.qa1.orderdynamics.net/v1/orders/ 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "Channel": "CallCenter", 
  "OrderTotal": 124.64, 
  "CurrencyCode": "CA", 
  "ExternalOrderId": "",  
  "BillingCustomer": { 
     "InternalCustomerId": 88, 
     "ExternalCustomerId": "", 
     "UserId": "" 
     }, 
  "BillingAddress": { 
       "Id": 123, 
       "FirstName": "John", 
       "LastName": "Smith", 
       "CompanyName": "Tecsys", 
       "AddressLine1": "66 Leek", 
       "AddressLine2": "Unit B", 
       "City": "Toronto", 
       "State": "ON", 
       "ZipCode": "L3B4J4", 
       "CountryCode": "CA"
      }, 
  "ShippingAddress": 
       "Id": 123, 
       "FirstName": "John", 
       "LastName": "Smith", 
       "CompanyName": "Tecsys", 
       "AddressLine1": "66 Leek", 
       "AddressLine2": "Unit B", 
       "City": "Toronto", 
       "State": "ON", 
       "ZipCode": "L3B4J4", 
       "CountryCode": "CA"
    },
 "LineItems": [{ 
       "SKU": "Large_Red_Shirt", 
       "ExternalLineItemId": "", 
       "QuantityOrdered": 2, 
       "UnitPrice": 60.00, 
       "UnitDiscount": 0, 
       "Taxes": [{ 
          "InternalTaxRateId": 1, 
          "TaxRateBackendName": "ONtax",
          "Amount": 0.13 
}],

Get an Order

  • InternalOrderId

  • ExternalOrderId
    Note: You must supply either the Internal Order ID or the External Order ID but not both.

GET https://api.qa1.orderdynamics.net/v1/orders/?InternalOrderId=421152 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Payment Processing API

Endpoints

Required Parameters

Code Examples

Auto Invoice

  • Id

  • IdType

POST https://api.qa1.orderdynamics.net/v1/paymentprocessing/Invoices/AutoInvoice  Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "Id": "string", 
  "IdType": "Shipment" 
}

Create Sales Invoice by Details

  • InternalOrderID

  • DiscountTotal

  • ShippingTotal

  • InvoiceLineItems

  • Payments

POST https://api.qa1.orderdynamics.net/v1/paymentprocessing/Invoices/SalesInvoiceByDetails 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "ExternalOrderId": "", 
  "InternalOrderId": 412456, 
  "DiscountTotal": 0, 
  "ShippingTotal": 5.00, 
  "InvoiceLineItems": [{ 
     "CustomFields": [{ 
          "Name": "OrderStatus", 
          "Value": {"Paid} 
        }], 
      "InternalLineItemId": 2182, 
      "ExternalLineItemId": "", 
      "QuantityInvoiced": 2 
    }], 
   "Payments": [{ 
      "InternalOrderPaymentId": 2, 
      "Amount": 24.99, 
      "PaymentGatewayName": "Interac", 
      "ExternalOrderPaymentId": "" }] }

Get an Invoice

  • There are no required parameters. You can send the request and get a list of invoices.

GET https://api.qa1.orderdynamics.net/v1/paymentprocessing/Invoices?InvoiceStatus=PaymentPending&Type=SalesInvoice 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Physical Inventory API

Endpoint

Required Parameters

Code Examples

Bulk Update On-Hand Inventory

  • SKU

  • LocationInternalName

  • QuantityType

  • Quantity

PUT https://api.qa1.orderdynamics.net/v1/inventory/BulkOnhand 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API-KEY] [{ 
  "Sku": "7760558", 
  "LocationInternalName": "RichmondHill",
  "QuantityType": "Delta", 
  "Quantity": 10 
}]

Get Available Inventory

  • locationInternalNames

GET https://api.qa1.orderdynamics.net/v1/inventory/available?locationInternalNames=RichmondHill&pageSize=100&pageNumber=1 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get On-hand Inventory

  • locationInternalNames

GET https://api.qa1.orderdynamics.net/v1/inventory/onhand?locationInternalNames=RichmondHill&pageSize=100&pageNumber=1 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Pre-order API

Endpoint

Required Parameters

Code Examples

Get a Release Schedule

  • releaseScheduleId

GET https://api.qa1.orderdynamics.net/preorder/releaseschedules/v1/88 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Get a Wave

  • waveId

GET https://api.qa1.orderdynamics.net/preorder/waves/v1/88 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Get Release Dates by OrderDetailId

  • orderDetailId

GET https://api.qa1.orderdynamics.net/preorder/releasedates/v1/88 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Get Release Schedules

  • There are no required parameters. You can send the request and get a list of release schedules.

GET https://api.qa1.orderdynamics.net/preorder/releaseschedules/v1/ 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Get Waves

  • externalId

  • itemId

  • inventoryLocationId

    Note: You can only enter one of these for each API request.

GET https://api.qa1.orderdynamics.net/preorder/waves/v1/?externalId=27 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Pre-order Inventory Visibility API

Endpoint

Required Parameters

Code Examples

Get Pre-order Inventory by SKU

  • SKU

GET https://api.qa1.orderdynamics.net/v1/preorderinventory/?Sku=Large_Red_Shirt  
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Privileges API

Endpoint

Required Parameters

Code Examples

Get Privileges

  • There are no required parameters. You can send the request and get a list of privileges.

GET https://api.qa1.orderdynamics.net/privileges/v1?SortByColumn=Id 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Products API

Endpoint

Required Parameters

Code Examples

Create a Product

  • Brand

  • CanBeConsolidated

  • DefaultRetailPrice

  • Item

  • Manufacturer

  • MetaKeywords

  • ProductBackendName

  • ProductName

  • ShortDescription

  • TaxCode

  • Warehouse

POST https://api.qa1.orderdynamics.net/v1/products/?BindAllAttributes=false 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]  { 
  "Brand": "Brand 1", 
  "CanBeConsolidated": true, 
  "DefaultRetailPrice": 10, 
}, 
  "Item": { 
    "PrimaryItemName": "Item 1", 
    "ProductName": "Product 1", 
    "Sku": "Sku1" 
     }, 
  "Manufacturer": "Generic", 
  "MetaKeywords": "Product PN 1", 
  "ProductBackendName": "Product PN 1",
  "ProductName": "Product PN 1", 
  "ShortDescription": "Product PN 1", 
  "TaxCode": "Taxable Goods", 
  "Warehouse": "Default Warehouse", 
  "WholesalePrice": 20 
}

Delete a Product

  • ProductName

  • ProductBackendName
    Note: You must supply either ProductName or ProductBackendName but not both.

DELETE https://api.qa1.orderdynamics.net/v1/products/?ProductName=Large_Red_Shirt  Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get Products

  • There are no required parameters. You can send the request and get a list of products.

GET https://api.qa1.orderdynamics.net/v1/products/?LoadAttributes=false&LoadLocalizationData=false&pageSize=100&pageNumber=1  
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Returns API

Endpoints

Required Parameters

Code Examples

Cancel a Return

  • ReturnId

POST https://api.qa1.orderdynamics.net/v1/returns/Cancel
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY] { 
   "ReturnId": 1524 
}

Create/Update a Return

  • InternalReturnId

PUT https://api.qa1.orderdynamics.net/v1/returns/?InternalReturnId=1524 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]   { 
  "InternalOrderId": 0, 
  "ExternalOrderId": "", 
  "ShippingAmount": 0, 
  "Discount": 0,
  "ReturnExpiryDate": "2016-07-06", 
  "LineItems": [{ 
     "InternalLineItemId": 12345, 
     "ExternalLineItemId":"External-123",
     "SKU": "AP1234", 
     "Quantity": 1, 
     "SourceType": "Invoice", 
     "SourceId": 1, 
     "QuantityReturnedtoInventory": 1, 
     "Reason": "Damaged", 
     "ReturnPrice": 10, 
     "LocationInternalName": "Default", 
}],
  "Payments": { 
     "OrderPayments": [{ 
     "InternalOrderPaymentId": 1, 
     "PaymentGatewayName": "QAGateWay1",
     "Amount": 110 
    }
  }

Get Returns

  • There are no required parameters. You can send the request and get a list of returns.

GET https://api.qa1.orderdynamics.net/v1/returns/?ReturnStatus=Pending
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Shipping Centers API

Endpoints

Required Parameters

Code Examples

Create a Shipping Center

  • InternalName

  • PublicName

  • Address

  • Email

  • Phone Number

POST https://api.qa1.orderdynamics.net/v1/shippingcenters/ 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "InternalName": "Toronto South", 
  "PublicName": "Toronto South", 
  "AssociatedShippingCentersNames":["Toronto North", "Toronto West"], 
  "DaysofProcessedShipmentstoShow": 30,
  "Address": { 
     "AddressLine1": "7 Bloor St. East",
     "AddressLine2": "Unit 12", 
     "AddressLine3": "Block A", 
     "City": "Toronto", 
     "State": "ON", 
     "ZipCode": "M4W 3H1", 
     "CountryCode": "CA" 
   },
  "Email": "jane.smith@tecsys.com", 
  "PhoneNumber": "416-555-1234"
 } 
}

Delete a Shipping Center

  • shippingCenterInternalName

DELETE https://api.qa1.orderdynamics.net/v1/shippingcenters/?shippingCenterInternalName=Default%20Location 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get All Shipping Centers

  • There are no required parameters. You can send the request and get a list of shipping centers.

GET https://api.qa1.orderdynamics.net/v1/shippingcenters/?pageSize=100&pageNumber=1
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Shipping Rates API

Endpoints

Required Parameters

Code Examples

Get Shipping Rates

  • There are no required parameters. You can send the request and get a list of staff members.

GET https://api.qa1.orderdynamics.net /v1/shippingrates/?PageSize=100&PageNumber=1
Content-Type: application/json 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Get Shipping Rates for an Order

  • InternalOrderId

  • ExternalOrderId
    Note: You can only enter one of these for each API request.

GET https://api.qa1.orderdynamics.net/v1/shippingrates/order?InternalOrderId=429925&PageSize=100&PageNumber=1
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Staff API

Endpoints

Required Parameters

Code Examples

Get Staff

  • There are no required parameters. You can send the request and get a list of staff members.

GET https://api.qa1.orderdynamics.net/v1/staff/?SortByColumn=Id 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Store Locations API

Endpoints

Required Parameters

Code Examples

Create a Store Location

  • StoreInternalName

  • PublicName

  • Address

  • Email

  • Phone Number

POST https://api.qa1.orderdynamics.net/v1/storelocations/ 
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "StoreInternalName": "Toronto South",
  "PublicName": "Bloor East", 
  "Address": { 
    "AddressLine1": "7 Bloor St. East",
    "AddressLine2": "Unit 12", 
    "AddressLine3": "Block A", 
    "City": "Toronto", 
    "State": "ON", 
    "ZipCode": "M4W 3H1", 
    "CountryCode": "CA" 
  }, 
  "Email": "user@email.com", 
  "PhoneNumber": "416-555-1234", 
  "Active": true, 
  "Visible": true, 
  "AllowShipToStore": false, 
}

Delete a Store Location

  • storeInternalName

DELETE https://api.qa1.orderdynamics.net/v1/storelocations/?storeInternalName=torontosouth 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Get Store Locations

  • There are no required parameters. You can send the request and get a list of staff members.

GET https://api.qa1.orderdynamics.net/v1/storelocations/?pageSize=100&pageNumber=1  Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Taxes API

Endpoints

Required Parameters

Code Examples

Create/Update Taxes

  • InternalTaxRateId

  • BackendName

PUT https://api.qa1.orderdynamics.net/v1/taxes/
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY] { 
  "BackendName": "Tax123", 
   "DisplayName": "Tax123", 
   "AppliesToCountries": ["CA"], 
   "AppliesToProvinces": ["ON", "NS"], 
   "Active": true, 
   "TaxType": "Gross", 
   "EffectiveRates": [{ 
      "Rate": 1, 
      "StartDate": "2022-11-08T16:29:00.753Z", 
      "EndDate": "2023-11-08T16:29:00.753Z" }], 
  "LocalizedDisplayNames": [{ 
       "Culture": "en-CA", 
       "Name": "" 
  }]
 }

Delete Taxes

  • InternalTaxRateId

  • BackendName

DELETE https://api.qa1.orderdynamics.net/v1/taxes/?InternalTaxRateId=1524&BackendName=ONTax 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key:[YOUR_API_KEY]

Get Taxes

  • There are no required parameters. You can send the request and get a list of taxes.

GET https://api.qa1.orderdynamics.net/v1/taxes/?SortByColumn=InternalTaxRateId 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Tickets API

Endpoints

Required Parameters

Code Examples

Create Ticket

  • OriginEmail

  • OriginName

  • Subject

  • TicketType

  • Status

  • QueueId

POST https://api.qa1.orderdynamics.net/v1/tickets/  
Content-Type: application/json 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY] { 
  "InternalCustomerId": 88, 
  "ExternalCustomerId": "", 
  "InternalOrderId": 421578, 
  "ExternalOrderId": "", 
  "Subject": "Damage", 
  "OriginEmail": "user@tecsys.com", 
  "OriginName": "John Smith", 
  "AssignStaffId":88,
  "Priority": "Low", 
  "TicketType": "cases", 
  "Status": "Not Started", 
  "CreatedBy": "Jane Smith", 
  "Notifications": "Silent", 
  "Unread": true, 
  "QueueId": 1, 
  "AdditionalInformation": "" 
}

Get Ticket by ID

  • TicketId

GET https://api.qa1.orderdynamics.net/v1/tickets/?TicketId=1524&SortByColumn=DateCreatedUtc 
Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]

Virtual Inventory Visibility API

Endpoints

Required Parameters

Code Examples

Get Virtual Inventory

  • inventoryPoolGroupNames

GET https://api.qa1.orderdynamics.net/v1/virtualinventory/?inventoryPoolGroupNames=TestGroupName&pageSize=100&pageNumber=1  Cache-Control: no-cache 
Ocp-Apim-Subscription-Key: [YOUR_API_KEY]