Amazon Web Services, Inc.

AWS B2B Data Interchange

This is the Amazon Web Services B2B Data Interchange API Reference . It provides descriptions, API request parameters, and the XML response for each of the…

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the Amazon Web Services B2B Data Interchange API Reference . It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions. B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12. Rather than actually running a command, you can use the --generate-cli-skeleton parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton file .

Endpoints 30

Capability

  • POSTCreate capability/#X-Amz-Target=B2BI.CreateCapabilityInstantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into…
  • POSTDelete capability/#X-Amz-Target=B2BI.DeleteCapabilityDeletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
  • POSTGet capability/#X-Amz-Target=B2BI.GetCapabilityRetrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or…
  • POSTList capabilities/#X-Amz-Target=B2BI.ListCapabilitiesLists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information…
  • POSTUpdate capability/#X-Amz-Target=B2BI.UpdateCapabilityUpdates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform…

Partnership

  • POSTCreate partnership/#X-Amz-Target=B2BI.CreatePartnershipCreates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your…
  • POSTDelete partnership/#X-Amz-Target=B2BI.DeletePartnershipDeletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more…
  • POSTGet partnership/#X-Amz-Target=B2BI.GetPartnershipRetrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading…
  • POSTList partnerships/#X-Amz-Target=B2BI.ListPartnershipsLists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between…
  • POSTUpdate partnership/#X-Amz-Target=B2BI.UpdatePartnershipUpdates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading…

Profile

  • POSTCreate profile/#X-Amz-Target=B2BI.CreateProfileCreates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create…
  • POSTDelete profile/#X-Amz-Target=B2BI.DeleteProfileDeletes the specified profile. A profile is the mechanism used to create the concept of a private network.
  • POSTGet profile/#X-Amz-Target=B2BI.GetProfileRetrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.
  • POSTList profiles/#X-Amz-Target=B2BI.ListProfilesLists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the…
  • POSTUpdate profile/#X-Amz-Target=B2BI.UpdateProfileUpdates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.

Transformer

  • POSTCreate transformer/#X-Amz-Target=B2BI.CreateTransformerCreates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios: Inbound EDI : the Amazon Web Services customer receives an…
  • POSTDelete transformer/#X-Amz-Target=B2BI.DeleteTransformerDeletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a…
  • POSTGet transformer/#X-Amz-Target=B2BI.GetTransformerRetrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or…
  • POSTList transformers/#X-Amz-Target=B2BI.ListTransformersLists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a…
  • POSTUpdate transformer/#X-Amz-Target=B2BI.UpdateTransformerUpdates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document.…
  • POSTCreate starter mapping template/#X-Amz-Target=B2BI.CreateStarterMappingTemplateAmazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can…
  • POSTGenerate mapping/#X-Amz-Target=B2BI.GenerateMappingTakes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then…
  • POSTGet transformer job/#X-Amz-Target=B2BI.GetTransformerJobReturns the details of the transformer run, based on the Transformer job ID. If 30 days have elapsed since your transformer job was started, the system…
  • POSTList tags for resource/#X-Amz-Target=B2BI.ListTagsForResourceLists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
  • POSTStart transformer job/#X-Amz-Target=B2BI.StartTransformerJobRuns a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data…
  • POSTTag resource/#X-Amz-Target=B2BI.TagResourceAttaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and…
  • POSTTest conversion/#X-Amz-Target=B2BI.TestConversionThis operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI…
  • POSTTest mapping/#X-Amz-Target=B2BI.TestMappingMaps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in…
  • POSTTest parsing/#X-Amz-Target=B2BI.TestParsingParses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
  • POSTUntag resource/#X-Amz-Target=B2BI.UntagResourceDetaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile,…

API details

Base URL
https://b2bi.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
30 operations on 30 pathsPOST 30
Main resources
Capability 5Partnership 5Profile 5Transformer 5
Description format
AWS Smithy model, API version 2022-06-23

How to test the AWS B2B Data Interchange in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS B2B Data Interchange collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create capability” (POST /#X-Amz-Target=B2BI.CreateCapability), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS B2B Data Interchange?

This is the Amazon Web Services B2B Data Interchange API Reference . It provides descriptions, API request parameters, and the XML response for each of the… It is listed under Data & analytics and has 30 endpoints.

Who publishes the AWS B2B Data Interchange?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS B2B Data Interchange?

Requests go to https://b2bi.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS B2B Data Interchange?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS B2B Data Interchange have?

30 operations on 30 paths (30 POST). The largest groups are Capability, Partnership, Profile, Transformer.

Is forking the AWS B2B Data Interchange free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.