# Get customer order information by its identifiers. **GET /customer-orders/{id}** Sample request: GET /customer-orders/CDE0000000001 ## Servers - https://soget-api-integration.azure-api.net/customer-orders/v1: https://soget-api-integration.azure-api.net/customer-orders/v1 () ## Authentication methods - Bearer token & Api key ## Parameters ### Path parameters - **id** (string) Customer order identifier ## Responses ### 200 Successful operation. #### Body: application/json (object) - **customerOrderId** (string) Customer order identifier. - **type** (string) Order types (note that the value handled by this service is only Master):

Master: Global order.
Elementary: Order linked to one container.
SegmentTerminalEntrepot: The segment of Import order from the handling place to the warehouse.
SegmentEntrepotDepot: The segment of Import order from the warehouse to the empty return location.
SegmentDepotEntrepot: The segment of Export order from the empty release location to the warehouse.
SegmentEntrepotTerminal: The segment of Export order from the warehouse to the handling place.
SegmentTransfer: The segment of Transfer order. There are 3 cases:
- Transfer of a full export container from a warehouse to a loading terminal;
- Transfer of a full import container from an unloading terminal to a stripping or inspection location;
- Transfer of a container from an unloading terminal to a loading terminal.

- **status** (string) Updating information related to a stage of the logistics flow (example: delivery to the importer) is no longer possible once the associated event has been completed. Updating the order is no longer possible once all the events have been completed. The order cannot be canceled if it has the "Submitted" status or if all the events have been completed. List of order states:

Draft: The order has been integrated in draft mode in MouvONE and is awaiting validation.
Valid: Order has been validated.
Cancelled: After order was validated, it is cancelled.
Submitted: The order has been integrated into GedMouv and is awaiting processing by the carrier.
Rejected: The order could not be integrated into GedMouv.
InProcess: The order has been submitted to Gedmouv successfully and is in progress.
Accepted: The order has been accepted by the carrier.
Refused: The order was refused by the carrier.

- **histories** (array[object]) Histories of the order. - **container** (object) Information about the entity to be transported, usually a container. - **contractor** (object) Actor information. - **carrier** (object) Actor information. - **transportOrderNumber** (string) Number of transport order. - **date** (string(date-time) | null) Date of the customer order. ISO 8601 Extended Format - **sender** (string | null) Name of the person who created the order. - **clientReference** (string | null) Importer/Exporter reference. - **customsFlag** (string) Type of flows:

Import: Import flow.
Export: Export flow.
Transfer: Transfer flow.

- **priceInformation** (string | null) Comment about pricing. - **instructionsInformation** (string | null) Instructions for the driver. - **contractTermsInformation** (string | null) Information about the contract terms. - **comment** (string | null) General comments about the transport order. - **voyage** (object) Voyage information. ### 400 Bad request. #### Body: application/json (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 MouvONE.
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 MouvONE.
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 MouvONE.
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.

- **message** (string | null) Error message. ### 404 Customer order not found. #### Body: application/json (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 MouvONE.
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 MouvONE.
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 MouvONE.
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.

- **message** (string | null) Error message. [Powered by Bump.sh](https://bump.sh)