1. Babelway
  2. Babelway User Guide
  3. Chapter 4. Manage & Build

4.2.5.24. Tradeshift Gateway Out

This gateway allows you to send files directly to an account on Tradeshift.

 API Prefix 

 URL Prefix to call Tradeshift API. Default is https://api.tradeshift.com/tradeshift/rest/ 

 Connection type 

 Choose 'Tenant' to connect to your own Tradeshift account and send the document from there. Choose 'Van' if you don't have a Tradeshift account and you need to dispatch the document to the account of someone else. 

 Tenant Id 

 The Tradeshift tenantId to use. Use Babelway application in Tradeshift to retrieve this value. 

 Token 

 The Tradeshift token to use. Use Babelway application in Tradeshift to retrieve this value. 

 Secret 

 The Tradeshift token secret to use. Use Babelway application in Tradeshift to retrieve this value. 

 Consumer key 

 The Tradeshift consumer key to use to authenticate the Babelway application. This should be left empty in most of the case. 

 Consumer secret 

 The Tradeshift consumer secret to use to authenticate the Babelway application. This should be left empty in most of the case. 

 Retry on http return code 

 Comma separated list of error Http return code that should be retried. If the return code is not in the list, the message is set in error. The default is '502,503,504'. 

 Retry on patterns 

 Optional. If the HTTP response is success (HTTP code 2xx) and if the HTTP response matches one of the pattern(s) (regular expressions), the message will be retried. 

 API suffix 

 The Tradeshift API to call. Do not include the URL prefix. 

 Http Method 

 You can specify the http method to call. The default is PUT. 

 Request content type 

 The content type of the generic api request. The default is text/xml. 

 Response content type 

 The content type of the generic api response. The default is text/xml. 

 Connected gateway 

 Select zero, one or several gateways to receive the response from the Tradeshift API. 

 Document Profile 

 The Tradeshift document profile. 

 Van 

 The van id used by Tradeshift to find the business partner. 

 Country 

 The country used by Tradeshift to find the business partner. 

 Company Name 

 The company name used by Tradeshift to find the business partner. 

 Email 

 The email address used by Tradeshift to find the business partner. 

 Identifier Scheme 

 The identifier scheme used by Tradeshift to find the business partner. 

 Identifier Value 

 The identifier value of the scheme used by Tradeshift to find the business partner. 

 Additional query parameters 

 Key value pairs which will be added to the request. 

 Additional properties 

 Additional properties that can be set on the Tradeshift document. 

 Retry strategy 

 Allows you to determine what to do if call to remote server fails. If 'No retry' is chosen, the message will be put immediately in error. Other values allow to make some retries before setting the message in error. 

  • No retry
  • aggressive
  • Keep trying for 15 minutes
    • Will retries after 2, 4, 7, 10 and 15 minutes.
  • Keep trying for 1 hour 
    • Will retries after 2, 4, 8, 15, 30 and 60 minutes.
  • Keep trying for 3 hours 
    • Will do 6 retries in the first hour, then every hour.
  • Keep trying for 8 hours 
    • Will do 6 retries in the first hour, then every hour.
  • Keep trying for 1 day 
    • Will do 4 retries in the first hour, then every hour.
  • Keep trying for 3 days 
    • Will do 5 retries in the first 2 hours, then every 3 hours.
  • Keep trying for 5 days, once a day 
    • Will do One retry every day for 5 days at the same time as the first try.
  • Keep trying for 7 days 
    • Will do 5 retries in the first hour, then every 3 hours for 3 days, then every 6 hours.

 Connected Gateways 

 Select zero, one or several gateways to receive the response from the server. 

 User Metadata Transfer Strategy 

 The strategy that will be used to transfer the user metadata to the new message created in the connected gateways. 

 Lookup Table Id 

 The technical id of the lookup table. 

 

 

Note:

 

  • If there is a file name provided in the "Message In" or "Message Out" which contain ~ tilde character, All browser based on Chromium will replace the ~ tilde character by the _ underscore character when you try to download the file from the Babelway interface, For more details you can check this link https://bugs.chromium.org/p/chromium/issues/detail?id=479419
  • The maximum file size accepted by this gateway is 100/250 MB.

ScanIO Connection Type for Tradeshft Gateway

The ScanIO connection type for the Tradeshft gateway facilitates integration between babelway and ScanIO. Here are the parameters available for your use:

  1. Additional Query Parameters
    These parameters can be included in the POST call to customize the message sent to ScanIO. Please refer to the ScanIO documentation for specific additions. By default, the ScanIO document ID will match the message ID in babelway.

  2. Is VAN
    Enable this if you want to establish a VAN connection and POST the message to external/scanio/documents/van/.

  3. ScanIO-VANID
    This denotes the Van ID used in conjunction with IS VAN.

  4. Wait for Dispatch Stage
    If set as "true," the message will only reach a SUCCESS state in babelway when the document in ScanIO has been successfully dispatched. Otherwise, even if there hasn't been a FAILURE but processing od the documents in ScanIO is pending, it will still be marked as SUCCESS at the end of the retry strategy.

  5. Properties
    This segment allows you to include key-value pair properties that should be added to the TS document.

  6. Tags
    Use this section to add tags to your TS documents.