Mappings
Stedi mappings transform JSON documents from one structure to another. For example, you could create a mapping to transform incoming JSON between the following shapes.
Source shape
{
"product": {
"id": "QL-5490S",
"price": "USD 500"
}
}
Target shape
{
"product_number": "QL-5490S",
"price": {
"currency": "USD",
"amount": 500
}
}
First, you must create a mapping definition with the Mappings UI or the Mappings API. Then, you can use that definition to transform JSON documents with the Mappings API.
Use Cases
You may want to use mappings for one or more of the following use cases:
- Transform into or out of EDI-like JSON when using Stedi Core
- An API expects data in a structure that's different than what your own software system uses
- Map data from one transaction set, like a purchase order, directly onto another transaction set, like an invoice
Transform EDI-like JSON
Stedi Core transforms data between EDI and JSON. However, Core expects and outputs EDI-like JSON, a JSON shape that represents an EDI document.
You can use mappings in conjunction with Core to transform EDI data into and out of the shape required for your internal systems. In this case, we recommend creating a mapping based the Stedi guide that Core uses to read or write EDI.
Feedback
Have an idea for something we could improve? Page not clear? We love feedback - send us a message.