Understand integration environment variables
Learn how to work with the integration environment variables.
The following variables can be set as environment variables when deploying the integration container image:
Required Environment Properties
Secret Properties
Optional Environment Properties
The rest of this topic provides detailed information on how to work with the environment variables.
Required environment properties
The following are required environment properties:
| Property | Environment variable | Value | Notes |
|---|---|---|---|
commercetools.project.key |
| Your commercetools project key | |
commercetools.auth.url |
| commercetools auth endpoint | For example: https://auth.europe-west1.gcp.commercetools.com/oauth/token |
commercetools.api.url |
| commercetools API endpoint | For example: https://api.europe-west1.gcp.commercetools.com |
quarkus.oidc.auth.server.url |
| Merchant Center API URL for the region you are deployed to | For example: https://mc-api.europe-west1.gcp.commercetools.com. See Merchant Center documentation |
connector.base.url | CONNECTOR_BASE_URL | Public facing URL where you have deployed the integration | |
digital.river.shipping.callout.endpoint | DIGITAL_RIVER_SHIPPING_CALLOUT_ENDPOINT | URL where Digital River will load available shipping methods for a cart | Set to |
Secret properties
The following sensitive properties should be defined in in an application.yml file which is mounted at /secrets/application.yaml.
Note: For security reasons, it is recommended that you do not set them as environment variables.
| Property | Environment variable | Value | Notes |
|---|---|---|---|
commercetoold.client.id |
| Client id of your commercetools API key | See Key Creation |
commercetools.client.secret |
| Client secret of your commercetools API key | See Key Creation |
connector.secret.decryption-key |
| RSA private key used to decrypt secrets | See Key Creation |
Optional environment properties
The following properties have default values you may wish to override:
| Property | Environment variable | Value | Default value | Notes |
|---|---|---|---|---|
digital-river/mp-rest/url |
| Base URL for Digital River API | https://api.digitalriver.com | |
connector.mapping.address-state-from |
| commercetools address property to map to Digital River state | REGION | Can be REGION or STATE |
connector.product-sync.custom-object-timeout-seconds |
| Maximum seconds to wait for a commercetools custom object create/update call to complete | 30 | |
connector.product-sync.locale-key |
| Locale key to use when syncing product data | en | |
connector.product-sync.slug-url-format |
| String format to use to generate product URL from slug | null | Disabled when null |
connector.product-sync.list-sku-timeout-seconds |
| Maximum seconds to wait for a DR list skus call to complete | 30 | |
connector.product-sync.wait-time-between-requests-millis |
| Delay between calls to DR when syncing products | 300 | Can be reduced to speed up manual sync, but may cause 429 errors |
connector.product-sync.max-concurrent-requests |
| Concurrent requests to DR when syncing products | 1 | |
connector.product-sync.full-sync.update-batch-size |
| Batch size of calls to DR for full manual sync | 10 | Can be increaed to speed up manual sync, but may cause 429 errors |
connector.product-sync.full-sync.product-query-batch-size |
| Query size to load products from commercetools for full manual sync | 50 | |
connector.product-sync.full-sync.timeout-units |
| Units for maximum time allowed for a full sync to run for | MINUTES | |
connector.product-sync.full-sync.timeout |
| Maximum time allowed for a full sync to run for | 15 | |
connector.secret.cache-timeout-seconds |
| Seconds to cache DR secret API key and webhook secret | 600 | This is the maximum time for key rotation to take effect |
connector.fee-names.importer-tax | Map of language to value | en: "Importer tax" | Used as the name of the custom line item added to an order when Digital River determines importer tax is due | |
connector.fee-names.duty | Map of language to value | en: "Duty" | Used as the name of the custom line item added to an order when Digital River determines duty is due |
The following properties define the commercetools custom type keys and field names used by the integration. These only need to be changed if you have altered the definitions of any types. See Map shared data used in the integration for the meaning of these fields.
| Property | Environment variable | Default value |
|---|---|---|
commercetools.custom-types.payment.type |
| drPaymentFields |
commercetools.custom-types.payment.checkout-session-id |
| drCheckoutSessionId |
commercetools.custom-types.payment.client-ip-address |
| drClientIpAddress |
commercetools.custom-types.cart.line-item-type |
| drLineItemFields |
commercetools.custom-types.cart.digital-river-order-id |
| drOrderId |
commercetools.custom-types.cart.digital-river-line-item-id |
| drLineItemId |
commercetools.custom-types.cart.warehouse |
| drWarehouse |
commercetools.custom-types.cart.invoice-urls |
| drInvoiceUrls |
commercetools.custom-types.cart.credit-memo-urls |
| drCreditMemoUrls |
commercetools.custom-types.cart.digital-river-order-state |
| drOrderState |
commercetools.custom-types.cart.digital-river-fraud-state |
| drFraudState |
commercetools.custom-types.customer.tax-certificate-file-contents |
| drTaxCertificateFileContents |
commercetools.custom-types.customer.tax-certificate-file-name |
| drTaxCertificateFileName |
commercetools.custom-types.customer.tax-certificate-file-id |
| drTaxCertificateFileId. |
commercetools.custom-types.customer.tax-certificate-start-date |
| drTaxCertificateStartDate |
commercetools.custom-types.customer.tax-certificate-end-date |
| drTaxCertificateEndDate |
commercetools.custom-types.customer.tax-certificate-authority |
| drTaxCertificateAuthority |
commercetools.custom-types.customer.attach-source |
| drAttachSource |
commercetools.custom-types.customer.detach-source |
| drDetachSource |
commercetools.custom-types.customer.sources |
| drSources |
commercetools.custom-types.custom-object.general-container |
| digital_river |
commercetools.custom-types.custom-object.sync-record-container |
| digital_river_sync_record |
commercetools.custom-types.custom-object.secret-api-key |
| secret_api_key |
commercetools.custom-types.custom-object.webhook-secret |
| webhook_secret |
commercetools.custom-types.custom-object.sync-status |
| sync_status |
commercetools.custom-types.shipping-method.service-level |
| drServiceLevel |
commercetools.custom-types.product.eccn |
| drEccn |
commercetools.custom-types.product.tax-code |
| drTaxCode |
commercetools.custom-types.product.country-of-origin |
| drCountryOfOrigin |
commercetools.custom-types.product.sku-group-id |
| drSkuGroupId |
commercetools.custom-types.product.part-number |
| drPartNumber |
Last updated