GTMS Provides ready-to-go REST APIs with supporting tools and documentation, which provides the basic information about Wholesale Distribution industry template APIs.
\nThis Guides covers List of Interfaces in Wholesale Distribution, getting started guide, Authentication, Documentation of the Data Structures of the interfaces.
\nProduct Master
\nCustomer Master
\nSupplier Master
\nPurchase Transactions
\nSales Transactions
\nCondition Records
\nSupplier Contracts
\nCustomer Contracts
\nChargeback Contracts
\nCustomer Outgoing Payments
\nCustomer Outgoing Accruals
\nSupplier Outgoing Payments
\nSupplier Outgoing Accruals
\nBefore using these interfaces, Vistex will have to setup a tenant and provide the host URL & client credentials. will be generated and shared to the consumers.
\nThere are 2 ways of authorization we support.
\nOAuth2.0
\nBasic Authentication
\nRecommendation is to use OAuth2.0 over basic authentication unless there's a limitation on consumer side.
\nContact Vistex Support
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Wholesale Distribution GTMS Interface Guide","slug":"wholesale-distribution-gtms-interface-guide"}],"owner":"23147840","collectionId":"91c2d961-16d6-4f5b-ada8-b0e47b21659f","publishedId":"2sA358ekwv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-05T18:49:06.000Z"},"item":[{"name":"Products","item":[{"name":"Post Products","id":"52b2a8f7-d658-4deb-b68b-c4325bc101b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Header\": [\r\n {\r\n \"Action\": \"{Type: String, Title: Action, MaxLength: 1, Required:false}\",\r\n \"ProductType\": \"{Type: String, Title: Material Type, MaxLength: 4, Required:false,DefaultValue:WXPR}\",\r\n \"ProductID\": \"{Type: String, Title: External Identification, MaxLength: 128, Required:true}\",\r\n \"Description\": \"{Type: String, Title: Description, MaxLength: 40, Required:true}\",\r\n \"BaseUnitOfMeasure\": \"{Type: String, Title: Base Unit of Measure, MaxLength: 3, Required:true}\",\r\n \"Group1\": \"{Type: String, Title: Product Group 1, MaxLength: 10, Required:false}\",\r\n \"Group2\": \"{Type: String, Title: Product Group 2, MaxLength: 10, Required:false}\",\r\n \"Group3\": \"{Type: String, Title: Product Group 3, MaxLength: 10, Required:false}\",\r\n \"Supplier\": \"{Type: String, Title: Vendor, MaxLength: 10, Required:false}\",\r\n \"Manufacturer\": \"{Type: String, Title: Manufacturer, MaxLength: 10, Required:false}\",\r\n \"Group4\": \"{Type: String, Title: Product Group 4, MaxLength: 4, Required:false}\",\r\n \"Group5\": \"{Type: String, Title: Product Group 5, MaxLength: 4, Required:false}\",\r\n \"Group6\": \"{Type: String, Title: Product Group 6, MaxLength: 4, Required:false}\",\r\n \"Group7\": \"{Type: String, Title: Product Group 7, MaxLength: 4, Required:false}\",\r\n \"EANNumber\": \"{Type: String, Title: European Article Number, MaxLength: 128, Required:false}\",\r\n \"UPCNumber\": \"{Type: String, Title: Universal Product Code, MaxLength: 128, Required:false}\",\r\n \"MPNNumber\": \"{Type: String, Title: Manufacturer Part Number, MaxLength: 128, Required:false}\",\r\n \"GTNNumber\": \"{Type: String, Title: GTN, MaxLength: 128, Required:false}\",\r\n \"DiscountinuedProdDate\": \"{Type: Date, Title: Discountinued Product Date, MaxLength: 8, Required:false} \",\r\n \"BuyerID\": \"{Type: String, Title: Buyer ID, MaxLength: 70, Required:false}\",\r\n \"Department\": \"{Type: String, Title: Department, MaxLength: 70, Required:false}\",\r\n \"BussinessUnit\": [\r\n {\r\n \"BusinessUnit\": \"{Type: String, Title: Business Unit, MaxLength: 4, Required:false}\",\r\n \"Group7\": \"{Type: String, Title: Product Group 7, MaxLength: 10, Required:false}\",\r\n \"Group8\": \"{Type: String, Title: Product Group 8, MaxLength: 10, Required:false}\",\r\n \"Group9\": \"{Type: String, Title: Product Group 9, MaxLength: 4, Required:false}\",\r\n \"ProfitCenter\": \"{Type: String, Title: Profit Center, MaxLength: 4, Required:false}\"\r\n }\r\n ],\r\n \"UnitOfMeasure\": [\r\n {\r\n \"UnitOfMeasure\": \"{Type: String, Title: Unit of Measure, MaxLength: 3, Required:false}\",\r\n \"Numerator\": \"{Type: Decimal Nu, Title: Numerator, MaxLength: 5, Required:false}\",\r\n \"Denominator\": \"{Type: Decimal Nu, Title: Denominator, MaxLength: 5, Required:false}\",\r\n \"BaseUnitIndicator\": \"{Type: String, Title: Base Unit of Measure, MaxLength: 1, Required:false}\",\r\n \"Length\": \"{Type: Number, Title: Length, MaxLength: 13, Required:false}\",\r\n \"Height\": \"{Type: Number, Title: Height, MaxLength: 13, Required:false}\",\r\n \"Width\": \"{Type: Number, Title: Width, MaxLength: 13, Required:false}\",\r\n \"DimensionUnit\": \"{Type: String, Title: Dimension Unit, MaxLength: 3, Required:false}\",\r\n \"NetWeight\": \"{Type: Number, Title: Net Weight, MaxLength: 15, Required:false}\",\r\n \"GrossWeight\": \"{Type: Number, Title: Gross Weight, MaxLength: 15, Required:false}\",\r\n \"WeightUnit\": \"{Type: String, Title: Weight Unit, MaxLength: 3, Required:false}\",\r\n \"Volume\": \"{Type: Number, Title: Volume, MaxLength: 15, Required:false}\",\r\n \"VolumeUnit\": \"{Type: String, Title: Volume Unit, MaxLength: 3, Required:false}\"\r\n }\r\n ],\r\n \"Cost\": [\r\n {\r\n \"BusinessUnit\": \"{Type: String, Title: Business Unit, MaxLength: 4, Required:false}\",\r\n \"ValidFrom\": \"{Type: Date, Title: Valid From, MaxLength: 8, Required:false} \",\r\n \"ValidTo\": \"{Type: Date, Title: Valid To, MaxLength: 8, Required:false} \",\r\n \"CalculationRate\": \"{Type: Decimal Nu, Title: Rate, MaxLength: 24, Required:false}\",\r\n \"RateUnit\": \"{Type: String, Title: Unit, MaxLength: 5, Required:false}\",\r\n \"Per\": \"{Type: Decimal Nu, Title: Per, MaxLength: 24, Required:false}\",\r\n \"PerUnit\": \"{Type: String, Title: Unit, MaxLength: 5, Required:false}\",\r\n \"PayoutUnitType\": \"{Type: String, Title: Basis Unit Type, MaxLength: 4, Required:false}\"\r\n }\r\n ],\r\n \"Descriptions\": [\r\n {\r\n \"LanguageKey\": \"\",\r\n \"Description\": \"{Type: String, Title: Description, MaxLength: 40, Required:false}\"\r\n }\r\n ],\r\n \"Identifications\": [\r\n {\r\n \"IdentificationType\": \"{Type: String, Title: Identification Type, MaxLength: 4, Required:false}\",\r\n \"ProductIdentification\": \"{Type: String, Title: Material Identification, MaxLength: 128, Required:false}\"\r\n }\r\n ],\r\n \"HeaderWithDate\": [\r\n {\r\n \"ValidFrom\": \"{Type: Date, Title: Valid From, MaxLength: 8, Required:false} \",\r\n \"ValidTo\": \"{Type: Date, Title: Valid To, MaxLength: 8, Required:false} \",\r\n \"Group4\": \"{Type: String, Title: Product Group 4, MaxLength: 10, Required:false}\",\r\n \"Group5\": \"{Type: String, Title: Product Group 5, MaxLength: 10, Required:false}\",\r\n \"Group6\": \"{Type: String, Title: Product Group 6, MaxLength: 4, Required:false}\",\r\n \"Hierarchy\": \"{Type: String, Title: Product Hierarchy, MaxLength: 60, Required:false}\"\r\n }\r\n ],\r\n \"BussinessUnitWithDate\": [\r\n {\r\n \"BusinessUnit\": \"{Type: String, Title: Business Unit, MaxLength: 4, Required:false}\",\r\n \"ValidFrom\": \"{Type: Date, Title: Valid From, MaxLength: 8, Required:false} \",\r\n \"ValidTo\": \"{Type: Date, Title: Valid To, MaxLength: 8, Required:false} \",\r\n \"Group10\": \"{Type: String, Title: Product Group 10, MaxLength: 10, Required:false}\",\r\n \"Group11\": \"{Type: String, Title: Product Group 11, MaxLength: 10, Required:false}\",\r\n \"Group12\": \"{Type: String, Title: Product Group 12, MaxLength: 4, Required:false}\"\r\n }\r\n ],\r\n \"MultiValueAttrsGroup1\": [\r\n {\r\n \"MultiValueGroup1\": \"{Type: String, Title: Product Group 13, MaxLength: 4, Required:false}\"\r\n }\r\n ],\r\n \"MultiValueAttrsGroup2\": [\r\n {\r\n \"MultiValueGroup2\": \"{Type: String, Title: Product Group 14, MaxLength: 4, Required:false}\"\r\n }\r\n ],\r\n \"MultiValueAttrsGroup3\": [\r\n {\r\n \"MultiValueGroup3\": \"{Type: String, Title: Product Group 15, MaxLength: 4, Required:false}\"\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://<Create Product master, with reference to Product master entity in GTMS application. API Endpoint is 'Products', API definition is explained below with success and failure examples.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'Products', below body shows the entire payload of Product Master API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: Products
\nThis GTMS interface supports all CRUD operations. Using this synchronous API enables you to Create, Change, Read & Delete Product Master details in/from GTMS.
\nProduct Master API holds Products, Materials, SkUs master data. This object has following data sections with cardinality mentioned for respective section in bracket.
\nHeader Data - General Data about the products.
\nHeader with Date - Header Attributes with Validity
\nBusiness Unit - General Data about the Business Unit
\nBusiness Unit with Date - Business Unit with Validity
\nIdentification - Various identification numbers for the Product
\nDescriptions - Long description in different languages
\nUnit of Measure - Data about the various Unit of Measurement
\nCost - Product cost data with validity
\nMulti Value Attributes Group - Group of Attributes having multiple values
\nSuccess & Failure examples are provided as reference.
\n","event":[{"listen":"prerequest","script":{"id":"ffbb5830-3d2d-4b2f-89af-1d34a4c13e1e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c9138814-4e67-49bd-855b-c73424168781","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"685dbe2d-eeb3-4839-be33-107ac192c422","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'Customers', below body shows the entire payload of Customer Master API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'Customers', below body shows the entire payload of Customer Master API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: Customers
\nThis GTMS Interface Supports all CRUD operations. Using this synchronous API enables you to Create, Change, Read & Delete Customer Master details in/from GTMS.
\nCustomer Master API stores Customer or Business partner master data. This object has following data sections with cardinality mentioned for respective section in bracket.
\nHeader Data - General Data about the Customers
\nHeader Attributes with Dates - Header Attributes with Validity
\nAddress - Different address detail like Standard address, Mailing Address , etc.
\nContact Methods - Detail about the Contact detail with preference like Email, Cell phone, etc..
\nBusiness Unit - General Data about the Business Unit
\nBusiness Unit with Date - Business Unit with Validity
\nCompany Attributes - General Data about the Company
\nIdentifications - Various identification numbers for the Customer
\nMulti Value Attributes Group - Group of Attributes having multiple values.
\nSuccess & Failure examples are provided as reference.
\n","_postman_id":"16a1dd92-94ba-4b7d-9bcf-a6117a140dab","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'Suppliers', below body shows the entire payload of Supplier Master API with each field characteristics.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a0af3519-8633-44a8-89ad-b56da016d30e","id":"a0af3519-8633-44a8-89ad-b56da016d30e","name":"Suppliers","type":"folder"}},"urlObject":{"protocol":"https","path":["gateway","vpi","Suppliers"],"host":["<Hostname would be specific to the tenant/customer. API Endpoint is 'Suppliers', below body shows the entire payload of Supplier Master API with each field characteristics.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"a0af3519-8633-44a8-89ad-b56da016d30e","id":"a0af3519-8633-44a8-89ad-b56da016d30e","name":"Suppliers","type":"folder"}},"urlObject":{"protocol":"https","path":["gateway","vpi","Suppliers"],"host":["<API Endpoint: Suppliers
\nThis GTMS interface supports all CRUD operations. Using this synchronous API enables you to Create, Change, Read & Delete Supplier Master details in/from GTMS.
\nSuppliers API, is used to stores Supplier or Business partner master data. This object has following data sections with cardinality mentioned for respective section in bracket.
\nHeader Data - General Data about the Suppliers
\nHeader Attributes with Dates - Header Attributes with Validity
\nAddress - Different address detail like Standard address, Mailing Address , etc.
\nContact Methods - Detail about the Contact detail with preference like Email, Cell phone, etc..
\nBusiness Unit - General Data about the Business Unit
\nBusiness Unit with Date - Business Unit with Validity
\nCompany Attributes - General Data about the Company
\nIdentifications - Various identification numbers for the Supplier
\nMulti Value Attributes Group - Group of Attributes having multiple values
\nSuccess & Failure examples are provided as reference.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7f5bc9f7-0887-4c7d-bf2b-dc17c3df6f3f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"8184e293-c981-47e4-aca1-a3f0b74e2eb8","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"a0af3519-8633-44a8-89ad-b56da016d30e"},{"name":"PurchaseTransactions","item":[{"name":"Post Purchase Transactions","id":"7f231de1-a5ac-47d2-91c1-147c2c0596fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Items\": [\r\n {\r\n \"ExternalDocumentNumber\": \"{Type: String, Title: External Document Number, MaxLength: 128, Required:true}\",\r\n \"ExternalItemNumber\": \"{Type: String, Title: External Item Number, MaxLength: 10, Required:false}\",\r\n \"LineID\": \"{Type: String, Title: Line GUID, MaxLength: 250, Required:false}\",\r\n \"PurTransactionType\": \"{Type: String, Title: Provided Transaction Type, MaxLength: 6, Required:false}\",\r\n \"LineType\": \"{Type: String, Title: Line Type, MaxLength: 1, Required:false}\",\r\n \"ItemType\": \"{Type: String, Title: Item Type, MaxLength: 6, Required:false}\",\r\n \"Product\": \"{Type: String, Title: Product ID, MaxLength: 10, Required:false}\",\r\n \"Quantity\": \"{Type: Decimal Nu, Title: Quantity, MaxLength: 15, Required:false}\",\r\n \"NetPrice\": \"{Type: Currency, Title: Net Price, MaxLength: 11, Required:false}\",\r\n \"DetUnitofMeasure\": \"{Type: String, Title: Determined Unit of measure, MaxLength: 3, Required:false}\",\r\n \"ProvUnitofMeasure\": \"{Type: String, Title: Provided Unit of Measure, MaxLength: 20, Required:false}\",\r\n \"PurchaseOrderNumber\": \"{Type: String, Title: Purchase Order Number, MaxLength: 20, Required:false}\",\r\n \"PurchaseOrderDate\": \"{Type: Date, Title: Purchase Order Date, MaxLength: 8, Required:false} \",\r\n \"GoodsReceiptDate\": \"{Type: Date, Title: Goods Receipt Date, MaxLength: 8, Required:false} \",\r\n \"Company\": \"{Type: String, Title: Company, MaxLength: 4, Required:false}\",\r\n \"BusinessUnit\": \"{Type: String, Title: Business Unit, MaxLength: 4, Required:false}\",\r\n \"Warehouse\": \"{Type: String, Title: Warehouse, MaxLength: 10, Required:false}\",\r\n \"Region\": \"{Type: String, Title: Region, MaxLength: 3, Required:false}\",\r\n \"Supplier\": \"{Type: String, Title: Supplier, MaxLength: 10, Required:false}\",\r\n \"ShippingFrom\": \"{Type: String, Title: Ship From(Location), MaxLength: 10, Required:false}\",\r\n \"PriceElement1\": \"{Type: Decimal Nu, Title: Price Element 1, MaxLength: 15, Required:false}\",\r\n \"PriceElement2\": \"{Type: Decimal Nu, Title: Price Element 2, MaxLength: 15, Required:false}\",\r\n \"PriceElement3\": \"{Type: Decimal Nu, Title: Price Element 3, MaxLength: 15, Required:false}\",\r\n \"PriceElement4\": \"{Type: Decimal Nu, Title: Price Element 4, MaxLength: 15, Required:false}\",\r\n \"PriceElement5\": \"{Type: Decimal Nu, Title: Price Element 5, MaxLength: 15, Required:false}\",\r\n \"NetValue\": \"{Type: Currency, Title: Net Value, MaxLength: 15, Required:false}\",\r\n \"Currency\": \"{Type: Currency, Title: Currency, MaxLength: 5, Required:true}\",\r\n \"ProductGroup1\": \"{Type: String, Title: Product Group 1, MaxLength: 10, Required:false}\",\r\n \"ProductGroup7\": \"{Type: String, Title: Product Group 7, MaxLength: 10, Required:false}\",\r\n \"ProductGroup10\": \"{Type: String, Title: Product Group 10, MaxLength: 10, Required:false}\",\r\n \"SupplierGroup1\": \"{Type: String, Title: Supplier Group 1, MaxLength: 4, Required:false}\",\r\n \"SupplierGroup7\": \"{Type: String, Title: Supplier Group 7, MaxLength: 4, Required:false}\",\r\n \"SupplierSegment\": \"{Type: String, Title: Supplier Segment, MaxLength: 4, Required:false}\",\r\n \"SupplierType\": \"{Type: String, Title: Supplier Type, MaxLength: 4, Required:false}\",\r\n \"SupplierClassification\": \"{Type: String, Title: Supplier Classification, MaxLength: 4, Required:false}\",\r\n \"ProfitCenter\": \"{Type: String, Title: Profit Center, MaxLength: 4, Required:false}\",\r\n \"TransactionField1\": \"{Type: String, Title: Purchase Tran fld 1, MaxLength: 4, Required:false}\",\r\n \"TransactionField2\": \"{Type: String, Title: TransactionFld2, MaxLength: 20, Required:false}\",\r\n \"TransactionField3\": \"{Type: String, Title: Transaction Field 3, MaxLength: 20, Required:false}\",\r\n \"TransactionField4\": \"{Type: String, Title: Transaction Field 4, MaxLength: 20, Required:false}\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://<Hostname would be specific to the tenant/customer. API Endpoint is 'PurchaseTransactions', below body shows the entire payload of Purchase Transactions API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'PurchaseTransactions', below body shows the entire payload of Purchase Transactions API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: PurchaseTransactions
\nThis GTMS interface supports all CRUD operations. Using this synchronous API enables you to Create, Change, Read & Delete Purchase Transaction in/from GTMS. This object has following data section with cardinality mentioned in bracket.
\nSuccess & Failure examples are provided as reference.
\n","_postman_id":"9d00f008-eac6-4762-95ea-b51d58a99d23","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'SalesTransactions', below body shows the entire payload of Sales Transactions API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'SalesTransactions', below body shows the entire payload of Sales Transactions API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: SalesTransactions
\nThis GTMS interface supports all CRUD operations. Using this synchronous API enables you to Create, Change, Read & Delete Sales Transactions in/from GTMS. This object has following data section with cardinality mentioned in bracket.
\nSuccess & Failure examples are provided as reference.
\n","_postman_id":"d6e8146b-d070-44b5-b3f9-cde3688cd1f0","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'ConditionRecords', below body shows the entire payload of Condition Records API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'ConditionRecords', below body shows the entire payload of Condition Records API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: ConditionRecords
\nThis GTMS API supports, all CRUD operations. Using this synchronous API enables you to read, Create, Change, Read & Delete Condition Records in/from GTMS. This object has following data section with cardinality mentioned in bracket.
\nSuccess & Failure examples are provided as reference.
\n","_postman_id":"58ef688c-55eb-4d65-ad7c-d2d4bed3b99d","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'SupplierOutgoingPayments', below body shows the entire payload of Supplier Outgoing Payments API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: SupplierOutgoingPayments
\nThis GTMS API supports, GET operation. Using this synchronous API enables you to Read Supplier rebate settlement Records in GTMS. All the required details are in Header and Item sections. This object has following data sections with cardinality mentioned for respective section in bracket.
\nSuccess & Failure examples are provided as reference.
\n","_postman_id":"e0850b64-ffc0-451b-9903-ecc2ba693bc1","auth":{"type":"oauth2","oauth2":{"clientSecret":"Hostname would be specific to the tenant/customer. API Endpoint is 'SupplierOutgoingPayments', below body shows the entire payload of Supplier Outgoing Payments API with each field characteristics.
\n","auth":{"type":"oauth2","oauth2":{"clientSecret":"API Endpoint: