Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog,
and this project adheres to Semantic Versioning.

[0.35.0] - 2025-03-25

Added

• Listings:
  • The GET /listings/product and GET /listings/product/:id endpoints now have an optional query ip allowing to specify only listings from within a country.
  • This way clients from Netherlands don't get listings from The USA.

[0.34.0] - 2025-02-26

Added

• Listings:
  • The POST /listings endpoint now requires a mandatory field called returnReason.
• Retailers:
  • Retailers now store a list of supported countries in a field called countries.

[0.33.0] - 2025-02-19

Added

• ** New Endpoint**:
  • POST /regular-return:
    • Summary Creates a regular return.
    • Description: A request includes the webshop order ID, the customer's details and a list of products to be returned. Returned products must have a valid reason, a carrier and a SKU. Returns can be fetched for a tenant by issuing a GET request to regular-return or /regular-return/:webshopOrderID.

[0.32.0] - 2025-02-11

Added

• POST /listings Request and Response Updates:

  • Introduced two new optional fields:
    • quantity (integer): Specifies the quantity of the product to be added. (Example: 1)
    • maxQuantity (integer): Defines the maximum quantity of the product (matching the order quantity). (Example: 3)

• New Endpoints:

  • POST /orders/commit:

    • Summary: Commits an order to the database.
    • Description: Orders are initially committed to prevent errors during order creation. If no issues arise, the retailer can proceed with payment. The order must later be confirmed or rejected via /orders/finalize/:id.

  • POST /orders/finalize/{orderId}:

    • Summary: Confirms or rejects an order.
    • Description: Based on the action in the request body, the order is either confirmed or rejected. If rejected, the associated listing is set back to Available, and all related data is deleted.

Changed

• POST /listings Response:
  • Now returns a list of Listing[] objects instead of a single object.

Removed

• Endpoint Removed:
  • POST /listings/cancel/byOrderAndSku: This endpoint has been removed.

[0.31.0] - 2025-02-06

Added

• POST /warehouses/return-label Endpoint: Introduced a temporary implementation for generating return labels for warehouses.

Changed

• GET /carrier-contract-info Documentation: Updated to reflect the correct format.

[0.30.0] - 2025-01-21

Added

• Webhook Response Models Added to Docs:

  • Each model includes detailed descriptions of the fields and example payloads.

• GET /orders Query Parameter:

  • Introduced a new query parameter listingWebshopOrderId to the /orders endpoint.
    • Example: GET /orders?listingWebshopOrderId=12345
    • This query returns an array of all listings with a matching webshopOrderId.

[0.29.0] - 2024-11-27

Changed

• Carrier Name Changed : Changed the carrier name enum from DHL to DHL-eCommerce-Benelux.

• Order and Listing Schemas:

  • Renamed the reason field to cancelReason.
  • Changed cancelReason type from string to an enum with the following values:
    • NOT_DELIVERED_BY_CARRIER
    • CUSTOMER_BANNED
    • MATCHING_PERIOD_PASSED
    • RETURN_DEADLINE_PASSED
    • USER_CANCELLED.

• Carrier Names Enum:

  • Updated the enum to replace DHL with DHL-eCommerce-Benelux.

• Status field of Listing, Order, Shipment Enum:

  • Renamed Labeled to Labelled.
  • Renamed Canceled to Cancelled.

[0.28.0] - 2024-11-18

Added

• PUT /customers/ban: Updated to support banning a customer with the email provided in the request body instead of the path parameter.

• New Webhook Event Types: Added the following event types to webhook configurations:

  • LABELED: Triggered when the order is labeled.
  • SHIPPED: Triggered when the order is shipped.
  • COMPLETED: Triggered when the order is completed.

Changed

• PUT /customers/ban/{email}: The path parameter email is no longer required. Replaced with a request body schema
  • Request Body Example: "email@real.com"
• Customer Schema: Added required fields to the Customer schema:
  • firstName
  • lastName

[0.27.0] - 2024-11-11

Changed

  - `POST /orders`: carrierName field not required anymore. If not provided, first added carrier will be selected.

[0.26.0] - 2024-11-05

Added

• PUT /customers/ban/{email}: Introduced a new endpoint to ban a customer by their email.
• bannedEmails Field in Retailer Object: Added a bannedEmails field as an array of strings with a default empty array.

Changed

• GET /shipments Response: The response for fetching all shipments, or shipments by orderId or listingId, has been updated to include the corresponding warehouse object.
• GET /shipments/{shipmentId} Response: The response for fetching a shipment by shipmentId has been updated to include the corresponding warehouse object.
• /shipments/delivered/{shipmentId} Endpoint: Changed the request method for this endpoint from GET to PUT.

Removed

• /orders/{orderId}/cancel Endpoint: This endpoint has been removed.

[0.25.0] - 2024-10-22

Added

• GET /orders Query Parameter: Introduced a new optional query parameter options.
  • options=ordersDetails: Returns orders with only the fields sku, webshopOrderId, and listingWebshopOrderId, sorted by creation date.

[0.24.0] - 2024-10-15

Changed

• POST /shipments no longer requires the carrierName field.
• POST /orders now requires the carrierName field and has removed the webshopOrderItemId field.
• Listing Update Model: Updated the PUT /listings/{id} request body schema to reflect changes in the listing update process.

Removed

• PUT /orders/{id} and PUT /shipments/{id} endpoints have been removed.

[0.23.0] - 2024-10-07

Removed

• Tenant Endpoints: Removed the POST /tenant/ and DELETE /tenant/ endpoints.

Added

• Custom Error Classes: Introduced custom error classes for improved error handling, including:

  • NotFoundError
  • BadRequestError
  • ConflictError
  • ForbiddenError
  • UnauthorizedError
  • InternalError

• Error Status Code Updates: Updated the status codes returned for different errors based on the new custom error classes.

Changed

• Error Messages: Error responses now contain only short summaries of errors instead of full error messages.

[0.22.0] - 2024-10-01

Changed

• Listing Model:
  • The matched boolean field now defaults to false.
  • Removed the warehouseId field and its reference from the Listing model.
• Controller Renaming: Renamed the getUnmatchedListings controller to getAvailableListings controller for clarity.
• Status Update: Changed the create status to matched status in Listings, Orders, and Shipments models to reflect the updated workflow.

[0.21.0] - 2024-09-25

Added

• New Endpoint: Introduced /listings/nanoid/{id} to retrieve a listing by its nanoId, enhancing security by using random IDs in email frontends.
• Shipment Return Model: Extended to include the related Listing information.

Changed

• Retailer Update Bug Fix: Resolved an issue where retailers were unable to update their fields via the PUT request. Please refer to the updated documentation.
• Retailer Mandatory Fields: When creating a tenant, the following new fields are now required for email functionalities:
  • packageReceivedLink: Link to the feedback page for a received package.
    • Example: https://www.test.com/package-received/
  • returnCancelledLink: Link to the return label generation page.
    • Example: https://www.test.com/return-cancelled/
  • returnDeadlineLink: Link to the return package to the warehouse page.
    • Example: https://www.test.com/return-deadline/
  • matchMadeLink: Link to the matched order details page.
    • Example: https://www.test.com/match-made/
  • matchDeadlineLink: Link to the return package to the warehouse page for missed match deadlines.
    • Example: https://www.test.com/match-deadline/
  • forwardRegisteredLink: Link to the forward registered page.
    • Example: https://www.test.com/forward-registered/
• Listing Creation Request Body: Removed the status and discountRange fields. Refer to the updated API documentation for details.
• Tenant Creation Request: Now requires all the link specified above in added retailer mandatory fields.

Fixed

• OpenAPI Documentation: Corrected mistakes regarding warehouse models, added missing GET /shipments endpoint to the documentation, which returns all shipments for that tenant.

Dependencies

• Prisma: Updated from v5.18 to v5.20.