Introduction

TgExtApi was created to enable the creation and processing of orders on the tedgifted.com platform. The classes and methods presented below can be classified into three groups:

Basic class (Orders) – Allows creating orders (after prior validation), retrieving a list and details of orders created via the API, uploading a project for visualization, accepting or rejecting the prepared visualization, and downloading documents related to created orders.
Dictionary classes – Enable the retrieval of individual data components required for validation and order creation requests.
Notification class (Webhook) – Allows configuring an endpoint to which notifications related to the order will be sent, such as the need for visualization approval or status changes.

Order Processing

The order processing path depends on the selected approval method and the decision made after receiving the visualization or sample. In simplified terms, order processing follows these steps:

Preparing the order request using dictionary data.
Order validation – orders/validate.
Order creation (If validation is successful, a checksum and idempotency_key will be returned. These are required for the order creation request) – orders/create.
Uploading the project – orders/uploadProject. The submitted data will be checked by a graphic designer. If correct, a visualization will be prepared; otherwise, a comment will be added indicating the error.
Accepting or rejecting the visualization – orders/acceptOrReject. The prepared visualization must be reviewed and a decision made. You can:
- Accept the visualization (decision: acceptVisOrSample).
- Reject it and request a new one (decision: rejectVisOrSample).
- Reject it with the intention of re-uploading the project (decision: rejectVisOrSampleAndAdd).
If rejecting, you must provide at least one reason.
Accepting or rejecting samples – If you selected sample approval (photo or physical), a decision must be made again.
If the prepared visualization or sample (depending on the approval method) is accepted, the order will proceed to production.

From the moment the order is created, you can check its details (orders/details{orderId}), modify it (name and, to some extent, delivery details), and download related documents (orders/getDocuments). Initially, a proforma invoice will be available, with additional invoices and WZ documents added later.

Authorization

After obtaining access (which requires prior contact with your account manager), you can generate API keys in your panel on tedgifted.com under the "Tedgifted API" tab. Two keys will be generated:

A production key for authentication on the production server (https://api.tedgifted.com/).
A sandbox key for sending requests to the test server (https://test-api.tedgifted.com).

You can also use the sandbox key for API requests made directly from the website (Click the "Authorize" button in the top right corner of the classes and methods list, then enter the sandbox key).

Webhook Class

This class allows configuring an endpoint and events (using * grants access to all notifications) for notifications automatically sent by the server when order changes occur. Currently, notifications are sent for the following events:

challenge – A basic, required event for endpoint verification.
order.changeStatus – Notifies about order status changes.
order.projectRequired – Notifies that a project upload is required. If a project was already uploaded, this means the designer rejected it.
order.acceptationRequired – Notifies that a decision on the visualization or sample is required.
order.fvIsReady – Notifies that an invoice document has been added to the order.

Notifications sent have the following structure:

{
  "event_type": "order.changeStatus",
  "oid": 156234,
  "utc_time": "2025-03-25T11:08:04Z",
  "source": "TgExtApi"
}

Request Responses

Regardless of the class and request type, responses follow the same structure. Each response contains a status field with a value of 0 or 1, indicating whether the request was successful. Most responses also include a data property containing an object or a list of objects.

If status is 0, an errors property may appear, listing any issues encountered. Additionally, each response includes a meta property. Inside it, you will find request_id, which you should provide to your account manager in case of issues to help resolve them faster. The meta property may also contain a pagination field with details for requests returning an array of objects.

Lanyards

Set a new password

Explore T-Quality before you place the order and get a sample pack.

Be up to date, subscribe to the newsletter.

TedGifted

Be up to date,
subscribe to the newsletter.