Przejdź do głównej zawartości

Wygeneruj tekst z szablonu podanego w żądaniu

POST
/api/v3/Renderer/RenderTextFromTemplate
curl --request POST \
--url https://twoja-instancja-renderer-api.enterprise.sellrocket.pl/api/v3/Renderer/RenderTextFromTemplate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "template": { "sections": { "order": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "orderHistory": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "lineItems": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "lineItemsList": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "lineItemsSummary": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "shipment": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "invoice": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "invoiceItems": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "invoiceVat": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "receipt": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "receiptItems": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "return": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "returnItems": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "message": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "payment": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "pickpack": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "stats": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" }, "orderStats": { "body": "example", "enabled": true, "orderBy": "example", "groupBy": "example" } }, "body": "example" }, "objects": { "type": "Order", "streamSubType": "Order", "ids": [ "example" ], "filter": "example" } }'

Renderuje tekst z treści szablonu przekazanej bezpośrednio w żądaniu, bez zapisywania go – przydatne do podglądu i testowania szablonów.

Example:

{
  "template": {
    "sections": {
      "order": {
        "body": "string",
        "enabled": true,
        "orderBy": "string"
      },
      ... (other sections)
    },
    "body": "string"
  },
  "objects": {
    "type": "Order",
    "streamSubType": "Order",
    "ids": [
      "string"
    ]
  }
}

The rendering request with inline template content.

Typ treściapplication/json
object
template
object
sections
object
order
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
orderHistory
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
lineItems
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
lineItemsList
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
lineItemsSummary
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
shipment
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
invoice
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
invoiceItems
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
invoiceVat
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
receipt
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
receiptItems
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
return
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
returnItems
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
message
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
payment
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
pickpack
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
stats
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
orderStats
object
body
string
nullable
enabled
boolean
orderBy
string
nullable
groupBy
string
nullable
body
string
nullable
objects
object
type
string
Dozwolone wartości: Order Connection Status LineItem LineItems EmailTemplate User OrderStats PimProduct PimProductsPage PimCatalog UserEvents StatusHistory ImageGalleryGetMany PimPriceGroup OrderShipmentConnections PimManufacturer PimManufacturers PimBundle PimBundles PimCategory PimCategories PimProductImage Connections ConnectionDefinitions ConnectionsAllGrouped PimComplexFields PimAllLanguages OrderHistory PimPriceGroups PimWarehouses
streamSubType
string
Dozwolone wartości: Order Connection Status LineItem LineItems EmailTemplate User OrderStats PimProduct PimProductsPage PimCatalog UserEvents StatusHistory ImageGalleryGetMany PimPriceGroup OrderShipmentConnections PimManufacturer PimManufacturers PimBundle PimBundles PimCategory PimCategories PimProductImage Connections ConnectionDefinitions ConnectionsAllGrouped PimComplexFields PimAllLanguages OrderHistory PimPriceGroups PimWarehouses
ids
Array<string>
nullable
filter
string
nullable

Success