Mapper API

Modified on Tue, 01 Dec 2020 at 03:27 PM

DEV:


SOAP WITH TRANSPORT AUTHENTIFICATION: https://dev-integration.techdinamics.com/Services/IntegrationQueueService.svc

REST/SOAP WITH PARAMETERS AUTHENTIFICATION: https://dev-integration.techdinamics.com/Services/IntegrationQueueServiceAlt.svc


PROD:


SOAP WITH TRANSPORT AUTHENTIFICATION: https://ui-integration.techdinamics.com/Services/IntegrationQueueService.svc

REST/SOAP WITH PARAMETERS AUTHENTIFICATION: https://ui-integration.techdinamics.com/Services/IntegrationQueueServiceAlt.svc


WSDL schema for SOAP WITH TRANSPORT AUTHENTIFICATION: 

https://ui-integration.techdinamics.com/Services/IntegrationQueueService.svc?singleWsdl


WSDL schema for SOAP WITH PARAMETERS AUTHENTIFICATION: 

https://ui-integration.techdinamics.com/Services/IntegrationQueueServiceAlt.svc?singleWsdl


REST documentation:
https://ui-integration.techdinamics.com/Services/IntegrationQueueServiceAlt.svc/help

 


Description:


Techdinamics mapper API supports both SOAP and REST access. 

For SOAP endpoints, you can use:

- SOAP service with transport message credentials. In this case you need to pass username/password provided to you by support using userName message credentials type (see https://docs.microsoft.com/en-us/dotnet/framework/wcf/feature-details/selecting-a-credential-type#transport-credential-types for reference)

- SOAP service with credentials passed as parameters to service method. If you will choose this approach, you will need to pass username/password with each request as parameters in addiiton to other parameters accepted by SOAP methods.


For REST endpoints, you can use both JSON and XML to pass parameters. Username/password needs to be sent with each request. You can find example of calling REST/JSON method with CURL at the following link: https://s3.amazonaws.com/mapper.samples/curlsample.zip



List of parameter names is same for all service types and can be found below.


Supported actions:


AddOutboundRecord

Send outbound document (order, replenishment, etc.) to WMS

Parameter
Type
Description
system
string
max 255
System name. Contact support to obtain value for your integration.
documentType
string
max 255
Document Type (ORDER, SHIPMENT, INVOICE, etc.). Contact support to obtain value for your integration.
revision
string
max 255
Document Type Revision
Use value 0
tradingPartnerCode
string
max 255
Your trading partner code.
Contact support to obtain value for your integration, or use ListTradingPartners method to obtain list of available values.
fileName
string
max 255
File name (tag). Any value can be used for this field.
contentBytes
byte array
Body of file. Contact support for example files for your integration


Return value: id of inserted record.


Authentificate

   Use this method to validate your user credentials without doing any actions in system. No parameters required to make this call. Method will throw exception if you use invalid credentials.


GetNextInboundRecords

Fetch next inbound document(s) (shipment, invoice, replenishment receipt) from pending queue

Parameter
Type
Description
system
String array
List of system names to query pending records. Contact support to obtain values for your integration.
documentType
string
Document Type (ORDER, SHIPMENT, INVOICE, etc.). Contact support to obtain value for your integration.
tradingPartnerCode
string
max 255
Your trading partner code.
Contact support to obtain value for your integration, or use ListTradingPartners method to obtain list of available values.
maxLength
Int
Count of files records to retrieve.


Return value: list of QueueRecord structures


GetOwnerPartnerCode

Get your own partner code. No paramerers. Deprecated. Use method ListOwnPartners.


Return value: your own partner code.


ListCanadianSalesTaxes

List of canadian tax by state defined in integrartion.


Return value: list of SalesTaxRecord structures


ListOwnPartners

List your all own partner codes.


Return value: list of TradingPartnerRecord structure


ListTradingItems

List available trading items (SKUs). No parameters.


Return value: list of TradingItemRecord structures


ListTradingPartners

List available trading partners which can be used for filfillment (warehouses). No parameters.


Return value: list of TradingPartnerRecord structure


PendingInboundCount

Count inbound documents in queue.


Parameter
Type
Description
system
String array
List of system names to query pending records. Contact support to obtain values for your integration.
documentType
string
Document Type (ORDER, SHIPMENT, INVOICE, etc.). Contact support to obtain value for your integration.
tradingPartnerCode
string
max 255
Your trading partner code.
Contact support to obtain value for your integration, or use ListTradingPartners method to obtain list of available values.


Return value: count of pending records in queue


SetInboundRecordStatus

Update inbound document status after processing (success, failure, etc.).

This method must be used after obtaining and processing record returned by GetNextInboundRecords


Parameter
Type
Description
queueRecordId
int
Record id to
status
enum
Available statuses:
New (0)
Success (1)
Failure (2)
Hold (3)
NoProcessing (4)
---
Records with status Success/Failure/Hold will be removed from results of GetNextInboundRecords
errorMessage
string
max 255
Optional error message.


No return value.


Additional Structures.


QueueRecord

Field
Type
Description
Id
Int
Queue record id,
System
string
max 255
System name. Contact support to obtain value for your integration.
DocumentType
string
max 255
Document Type (ORDER, SHIPMENT, INVOICE, etc.). Contact support to obtain value for your integration.
TradingPartner
TradingPartnerRecord structure
Trading partner associated with queue record
Tag
string
max 255
File name (tag). Any value can be used for this field.
contentBytes
byte array
Body of file. Contact support for example files for your integration

 

TradingPartner Record

Field
Type
Description
Code      
string
max 255
Trading partner record code
Name
string
max 255
Trading partner name

 

TradingItemRecord

Field
Type
Description
Code      
string
max 255
Trading item record code (SKU)
Name
string
max 255
Trading item name


SalexTaxRecord

Field
Type
Description
Code      
string
max 255
Sales tax record code
Name
string
max 255
Sales tax record name

 

 


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article