Smouv

Cancel a customer order.

DELETE /customer-orders/{orderId}
Bearer token & Api key

Sample request:

DELETE /customer-orders/CDE0000000001

Path parameters

  • orderId string Required

    Customer order identifier.

Responses

  • 200

    Successful operation.

  • 400

    Bad request.

    Hide response attributes Show response attributes object
    • timestamp string(date-time)

      Time information.

      ISO 8601 Extended Format

    • code string

      Error that could be returned by the system.

      • ACTOR_NOT_FOUND: Actor indicated in order doesn't exist in S'mouv.
      • ALREADY_JOINED_GROUP: User has already joined a group
      • CANNOT_CANCEL_NOT_MASTER_ORDER: You can only cancel an order if type of the order is Master. It's not allowed to cancel an Elementary or Segment order.
      • CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER: Order cannot be cancelled because the container has been associated with a booking.
      • CANNOT_CHANGE_NUMBER_OF_CONTAINERS: You can't change the number of containers when updating an order.
      • CANNOT_UPDATE_VALID_ORDER_TO_DRAFT: Cannot update order status from VALID to DRAFT.
      • CARRIER_EMAIL_REQUIRED: If carrier in the given order is unknown by GEDMOUV, then the carrier email is required.
      • CONFLICT: This error can happens if you try to update an order but it has been updated by another user so your version has been out-dated. You have to update your local version with the latest one before you can make any changes.
      • CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV: A contractor unknown by GEDMOUV is not allowed to create new transport order.
      • CUSTOMER_ORDER_NOT_FOUND: Order doesn't exist in S'mouv.
      • CUSTOMS_FLAG_NOT_BE_MODIFIED: You can't modify customs flag of an order.
      • EVENT_LOCATION_FIELDS_REQUIRED: The fields of event location is required.
      • EVENT_START_DATE_REQUIRED: Start date of event is required.
      • EXISTS_ORDER_WITH_HANDLING_UNIT_SPI: Exists order with the given handling unit spi.
      • HANDLING_UNIT_REFERENCE_INVALID: Reference of handling unit is invalid.
      • LIMIT_NONPOSITIVE: The LIMIT parameter must be greater than 0 when searching order.
      • NOT_SUPPORTED_ORDER_TYPE: The type of order is not supported for requested action.
      • OFFSET_NEGATIVE: The OFFSET parameter cannot be negative when searching order.
      • ORDER_ALREADY_CANCELED: The order has already been cancelled.
      • ORDER_DUPLICATED: You cannot create order if an order with the same characteristics already exists.
      • ORGANIZATION_ACTOR_CODE_INVALID: An organization must be verified by a SOGET administrator before its members can create and manage orders. Let's contact SOGET if you encounter this error.
      • ORGANIZATION_NOT_FOUND: A user must belong to an organization to be able to create and manage orders.
      • R0005: Cannot update information of containers and events.
      • R0006: Cannot update order if it is in certain status.
      • R0007: Cannot update container references.
      • R0008: Cannot cancel the order due to the status is Submitted or InProgress.
      • R0009: Cannot cancel the order that at least one of its segment is delivered.
      • SEARCH_DATE_ERROR: Date parameters is invalid when searching order.
      • UNKNOWN_LOCATION: Location is unknown by S'mouv.
      • USER_ID_INVALID: User ID is invalid.
      • WRONG_EVENT_DATE_ORDER: Dates of events must be in chronological order. For Import order: LadingImport -> DeliveryImport -> EmptyReleaseImport -> EmptyReturnImport. For Export order: EmptyReleaseExport -> PositioningExport -> LadingExport -> DeliveryExport.
      • WRONG_FORMAT: Order identifier is in wrong format.

      Values are ACTOR_NOT_FOUND, ALREADY_JOINED_GROUP, CANNOT_CANCEL_NOT_MASTER_ORDER, CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER, CANNOT_CHANGE_NUMBER_OF_CONTAINERS, CANNOT_UPDATE_VALID_ORDER_TO_DRAFT, CARRIER_EMAIL_REQUIRED, CONFLICT, CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV, CUSTOMER_ORDER_NOT_FOUND, CUSTOMS_FLAG_NOT_BE_MODIFIED, EVENT_LOCATION_FIELDS_REQUIRED, EVENT_START_DATE_REQUIRED, EXISTS_ORDER_WITH_HANDLING_UNIT_SPI, HANDLING_UNIT_REFERENCE_INVALID, LIMIT_NONPOSITIVE, NOT_SUPPORTED_ORDER_TYPE, OFFSET_NEGATIVE, ORDER_ALREADY_CANCELED, ORDER_DUPLICATED, ORGANIZATION_ACTOR_CODE_INVALID, ORGANIZATION_NOT_FOUND, R0005, R0006, R0007, R0008, R0009, SEARCH_DATE_ERROR, UNKNOWN_LOCATION, USER_ID_INVALID, WRONG_EVENT_DATE_ORDER, or WRONG_FORMAT.

    • message string | null

      Error message.

    Hide response attributes Show response attributes object
    • timestamp string(date-time)

      Time information.

      ISO 8601 Extended Format

    • code string

      Error that could be returned by the system.

      • ACTOR_NOT_FOUND: Actor indicated in order doesn't exist in S'mouv.
      • ALREADY_JOINED_GROUP: User has already joined a group
      • CANNOT_CANCEL_NOT_MASTER_ORDER: You can only cancel an order if type of the order is Master. It's not allowed to cancel an Elementary or Segment order.
      • CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER: Order cannot be cancelled because the container has been associated with a booking.
      • CANNOT_CHANGE_NUMBER_OF_CONTAINERS: You can't change the number of containers when updating an order.
      • CANNOT_UPDATE_VALID_ORDER_TO_DRAFT: Cannot update order status from VALID to DRAFT.
      • CARRIER_EMAIL_REQUIRED: If carrier in the given order is unknown by GEDMOUV, then the carrier email is required.
      • CONFLICT: This error can happens if you try to update an order but it has been updated by another user so your version has been out-dated. You have to update your local version with the latest one before you can make any changes.
      • CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV: A contractor unknown by GEDMOUV is not allowed to create new transport order.
      • CUSTOMER_ORDER_NOT_FOUND: Order doesn't exist in S'mouv.
      • CUSTOMS_FLAG_NOT_BE_MODIFIED: You can't modify customs flag of an order.
      • EVENT_LOCATION_FIELDS_REQUIRED: The fields of event location is required.
      • EVENT_START_DATE_REQUIRED: Start date of event is required.
      • EXISTS_ORDER_WITH_HANDLING_UNIT_SPI: Exists order with the given handling unit spi.
      • HANDLING_UNIT_REFERENCE_INVALID: Reference of handling unit is invalid.
      • LIMIT_NONPOSITIVE: The LIMIT parameter must be greater than 0 when searching order.
      • NOT_SUPPORTED_ORDER_TYPE: The type of order is not supported for requested action.
      • OFFSET_NEGATIVE: The OFFSET parameter cannot be negative when searching order.
      • ORDER_ALREADY_CANCELED: The order has already been cancelled.
      • ORDER_DUPLICATED: You cannot create order if an order with the same characteristics already exists.
      • ORGANIZATION_ACTOR_CODE_INVALID: An organization must be verified by a SOGET administrator before its members can create and manage orders. Let's contact SOGET if you encounter this error.
      • ORGANIZATION_NOT_FOUND: A user must belong to an organization to be able to create and manage orders.
      • R0005: Cannot update information of containers and events.
      • R0006: Cannot update order if it is in certain status.
      • R0007: Cannot update container references.
      • R0008: Cannot cancel the order due to the status is Submitted or InProgress.
      • R0009: Cannot cancel the order that at least one of its segment is delivered.
      • SEARCH_DATE_ERROR: Date parameters is invalid when searching order.
      • UNKNOWN_LOCATION: Location is unknown by S'mouv.
      • USER_ID_INVALID: User ID is invalid.
      • WRONG_EVENT_DATE_ORDER: Dates of events must be in chronological order. For Import order: LadingImport -> DeliveryImport -> EmptyReleaseImport -> EmptyReturnImport. For Export order: EmptyReleaseExport -> PositioningExport -> LadingExport -> DeliveryExport.
      • WRONG_FORMAT: Order identifier is in wrong format.

      Values are ACTOR_NOT_FOUND, ALREADY_JOINED_GROUP, CANNOT_CANCEL_NOT_MASTER_ORDER, CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER, CANNOT_CHANGE_NUMBER_OF_CONTAINERS, CANNOT_UPDATE_VALID_ORDER_TO_DRAFT, CARRIER_EMAIL_REQUIRED, CONFLICT, CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV, CUSTOMER_ORDER_NOT_FOUND, CUSTOMS_FLAG_NOT_BE_MODIFIED, EVENT_LOCATION_FIELDS_REQUIRED, EVENT_START_DATE_REQUIRED, EXISTS_ORDER_WITH_HANDLING_UNIT_SPI, HANDLING_UNIT_REFERENCE_INVALID, LIMIT_NONPOSITIVE, NOT_SUPPORTED_ORDER_TYPE, OFFSET_NEGATIVE, ORDER_ALREADY_CANCELED, ORDER_DUPLICATED, ORGANIZATION_ACTOR_CODE_INVALID, ORGANIZATION_NOT_FOUND, R0005, R0006, R0007, R0008, R0009, SEARCH_DATE_ERROR, UNKNOWN_LOCATION, USER_ID_INVALID, WRONG_EVENT_DATE_ORDER, or WRONG_FORMAT.

    • message string | null

      Error message.

    Hide response attributes Show response attributes object
    • timestamp string(date-time)

      Time information.

      ISO 8601 Extended Format

    • code string

      Error that could be returned by the system.

      • ACTOR_NOT_FOUND: Actor indicated in order doesn't exist in S'mouv.
      • ALREADY_JOINED_GROUP: User has already joined a group
      • CANNOT_CANCEL_NOT_MASTER_ORDER: You can only cancel an order if type of the order is Master. It's not allowed to cancel an Elementary or Segment order.
      • CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER: Order cannot be cancelled because the container has been associated with a booking.
      • CANNOT_CHANGE_NUMBER_OF_CONTAINERS: You can't change the number of containers when updating an order.
      • CANNOT_UPDATE_VALID_ORDER_TO_DRAFT: Cannot update order status from VALID to DRAFT.
      • CARRIER_EMAIL_REQUIRED: If carrier in the given order is unknown by GEDMOUV, then the carrier email is required.
      • CONFLICT: This error can happens if you try to update an order but it has been updated by another user so your version has been out-dated. You have to update your local version with the latest one before you can make any changes.
      • CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV: A contractor unknown by GEDMOUV is not allowed to create new transport order.
      • CUSTOMER_ORDER_NOT_FOUND: Order doesn't exist in S'mouv.
      • CUSTOMS_FLAG_NOT_BE_MODIFIED: You can't modify customs flag of an order.
      • EVENT_LOCATION_FIELDS_REQUIRED: The fields of event location is required.
      • EVENT_START_DATE_REQUIRED: Start date of event is required.
      • EXISTS_ORDER_WITH_HANDLING_UNIT_SPI: Exists order with the given handling unit spi.
      • HANDLING_UNIT_REFERENCE_INVALID: Reference of handling unit is invalid.
      • LIMIT_NONPOSITIVE: The LIMIT parameter must be greater than 0 when searching order.
      • NOT_SUPPORTED_ORDER_TYPE: The type of order is not supported for requested action.
      • OFFSET_NEGATIVE: The OFFSET parameter cannot be negative when searching order.
      • ORDER_ALREADY_CANCELED: The order has already been cancelled.
      • ORDER_DUPLICATED: You cannot create order if an order with the same characteristics already exists.
      • ORGANIZATION_ACTOR_CODE_INVALID: An organization must be verified by a SOGET administrator before its members can create and manage orders. Let's contact SOGET if you encounter this error.
      • ORGANIZATION_NOT_FOUND: A user must belong to an organization to be able to create and manage orders.
      • R0005: Cannot update information of containers and events.
      • R0006: Cannot update order if it is in certain status.
      • R0007: Cannot update container references.
      • R0008: Cannot cancel the order due to the status is Submitted or InProgress.
      • R0009: Cannot cancel the order that at least one of its segment is delivered.
      • SEARCH_DATE_ERROR: Date parameters is invalid when searching order.
      • UNKNOWN_LOCATION: Location is unknown by S'mouv.
      • USER_ID_INVALID: User ID is invalid.
      • WRONG_EVENT_DATE_ORDER: Dates of events must be in chronological order. For Import order: LadingImport -> DeliveryImport -> EmptyReleaseImport -> EmptyReturnImport. For Export order: EmptyReleaseExport -> PositioningExport -> LadingExport -> DeliveryExport.
      • WRONG_FORMAT: Order identifier is in wrong format.

      Values are ACTOR_NOT_FOUND, ALREADY_JOINED_GROUP, CANNOT_CANCEL_NOT_MASTER_ORDER, CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER, CANNOT_CHANGE_NUMBER_OF_CONTAINERS, CANNOT_UPDATE_VALID_ORDER_TO_DRAFT, CARRIER_EMAIL_REQUIRED, CONFLICT, CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV, CUSTOMER_ORDER_NOT_FOUND, CUSTOMS_FLAG_NOT_BE_MODIFIED, EVENT_LOCATION_FIELDS_REQUIRED, EVENT_START_DATE_REQUIRED, EXISTS_ORDER_WITH_HANDLING_UNIT_SPI, HANDLING_UNIT_REFERENCE_INVALID, LIMIT_NONPOSITIVE, NOT_SUPPORTED_ORDER_TYPE, OFFSET_NEGATIVE, ORDER_ALREADY_CANCELED, ORDER_DUPLICATED, ORGANIZATION_ACTOR_CODE_INVALID, ORGANIZATION_NOT_FOUND, R0005, R0006, R0007, R0008, R0009, SEARCH_DATE_ERROR, UNKNOWN_LOCATION, USER_ID_INVALID, WRONG_EVENT_DATE_ORDER, or WRONG_FORMAT.

    • message string | null

      Error message.
DELETE /customer-orders/{orderId} 
curl \
 --request DELETE 'https://soget-api-integration.azure-api.net/customer-orders/v1/customer-orders/{orderId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Ocp-Apim-Subscription-Key: $API_KEY"
Response examples (400) 
{
  "timestamp": "2022-11-08T14:17:19Z",
  "code": "ACTOR_NOT_FOUND",
  "message": "Commande de transport est introuvable!"
}
Response examples (400) 
{
  "timestamp": "2022-11-08T14:17:19Z",
  "code": "ACTOR_NOT_FOUND",
  "message": "Commande de transport est introuvable!"
}