githubEdit

lightbulbHelpful information

API versioning

The fulfillmenttools API is considered versionless. That means our API evolves in a backward-compatible way. The following changes are considered backward-compatible:

  • Adding new API resources.

  • Adding new optional request parameters to existing API methods.

  • Adding new properties to existing API responses.

  • Changing the order of properties in existing API responses.

  • Adding values to enums (see Enum Handling).

All endpoints, fields, and types in our APIs have a lifecycle ranging from Alpha to Beta to General Availability (GA). Additionally, we may deprecate certain functionality in our API.

For more detailed information, see API versioning and lifecycle.

Hosting

Our service is hosted on the Google Cloud Platform (GCP). We leverage products from different geographical regions. You can choose from a deployment in one of the following regions.

Available regions

circle-info

If your region isn't currently available, contact us using our contact formarrow-up-right.

Region code
Location

europe-west1

St. Ghislain, Belgium (default, if no region is preferred)

europe-west3

Frankfurt, Germany

europe-west4

Netherlands

europe-north1

Finland

us-east1

South Carolina, United States

us-east4

North Virginia, United States

us-central1

Iowa, United States

us-west1

Oregon, United States

asia-east1

Taiwan

asia-northeast1

Tokyo, Japan

asia-southeast1

Singapore

Backup policies

As a Software-as-a-Service (SaaS) solution, fulfillmenttools takes care of backups of your data automatically, you don't need to do anything. The following information should give you a first idea of how backups are being taken.

Regular backups

We impose a policy that takes backups:

  • Hourly (every hour of a day, 24/7)

  • Daily

  • Weekly

  • Monthly

By default, all of the above backup cycles are in place. The retention times (how long backups are stored and how long they remain restorable) vary. The backups are saved by default to the GCP zone europe-west1 with the option to duplicate them in another zone if desired.

Downloading the database or any other backups managed by fulfillmenttools isn't currently supported.

Point-in-time recovery (PITR)

We also provide a point-in-time recovery mechanism that lets you "go back in time" and is even more flexible for restoring backup data to a specific date in the past.

General Data Protection Regulation (GDPR)

fulfillmenttools is GDPRarrow-up-right-compliant.

All customer-related data needed for the fulfillment process (such as names, addresses, and contact details) is anonymized once all evolved entities are in a final operational state. The exact date for anonymization is configurable via API. The field retentionTime defines how many days after creation, operationally finished processes are anonymized. The default value is 30 days after the process is operationally finished.

Furthermore, anonymized entities are deleted after a configured period (default deletionTimeAfterRetention 180 days).

This deletion functionality only deletes operational data. The anonymized data is still stored for analytics.

Auditing is in place to track changes to entities (for example, pick job, order, and so on). The audit entries contain the date, the affected entity, the operation (for example, canceling an order, closing a pick job), and the username and the user ID of the user who performed the operation. GDPR configuration contains the attribute actorAnonymization. If it is missing or set to true, the username and user ID are stored in the audit entry in an anonymized form. If set to false, the data is written without being anonymized. The default value is true.

See the GDPR configuration article for more information.

Last updated