# Filter customer orders by given parameters.

**GET /customer-orders**

Sample request:
            
    GET /customer-orders?transportOrderNumber=TOC-02-03-2022&offset=0&limit=10&isProjection=true


## 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


### Query parameters
- **transportOrderNumber** (string)
  Transport order number.
- **containerNumber** (string)
  Container reference number.
- **carrierCode** (string)
  Carrier code.
- **processingIndicator** (string)
  Processing indicator.
- **startDate** (string(date-time))
  Start of search range for creation date (included)
- **endDate** (string(date-time))
  End of search range for creation date (included)
- **status** (string)
  Order status.
- **offset** (integer(int32))
  Index of the first returned result.
- **limit** (integer(int32))
  Number of results to be returned. Max value is 50.
- **desc** (boolean)
  Indicate the sorting order based on transport order id field. The default value is FALSE, which means the API will sort the returned list by ascending order.
- **isProjection** (boolean)
  Determine that response model should be a complete model or a light model.
               If this parameter is set to true, server returns the light version of segment.
               Otherwise, it will returns all order information.


## Responses
### 200
Successful operation.

#### Body: application/json (object)
- **total** (integer(int32))
  Number of total items
- **returned** (integer(int32))
  Number of items returned
- **first** (integer(int32))
  Position of the first element of the list among all the founded
- **items** (array[object] | null)
  List of items

### 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.<ul><li><i>ACTOR_NOT_FOUND</i>: Actor indicated in order doesn't exist in MouvONE.</li><li><i>ALREADY_JOINED_GROUP</i>: User has already joined a group</li><li><i>CANNOT_CANCEL_NOT_MASTER_ORDER</i>: You can only cancel an order if type of the order is Master. 
              It's not allowed to cancel an Elementary or Segment order.</li><li><i>CANNOT_CANCEL_ORDER_WITH_ASSOCIATED_CONTAINER</i>: Order cannot be cancelled because the container has been associated with a booking.</li><li><i>CANNOT_CHANGE_NUMBER_OF_CONTAINERS</i>: You can't change the number of containers when updating an order.</li><li><i>CANNOT_UPDATE_VALID_ORDER_TO_DRAFT</i>: Cannot update order status from VALID to DRAFT.</li><li><i>CARRIER_EMAIL_REQUIRED</i>: If carrier in the given order is unknown by GEDMOUV, then the carrier email is required.</li><li><i>CONFLICT</i>: 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.</li><li><i>CONTRACTOR_UNAUTHORIZED_BY_GEDMOUV</i>: A contractor unknown by GEDMOUV is not allowed to create new transport order.</li><li><i>CUSTOMER_ORDER_NOT_FOUND</i>: Order doesn't exist in MouvONE.</li><li><i>CUSTOMS_FLAG_NOT_BE_MODIFIED</i>: You can't modify customs flag of an order.</li><li><i>EVENT_LOCATION_FIELDS_REQUIRED</i>: The fields of event location is required.</li><li><i>EVENT_START_DATE_REQUIRED</i>: Start date of event is required.</li><li><i>EXISTS_ORDER_WITH_HANDLING_UNIT_SPI</i>: Exists order with the given handling unit spi.</li><li><i>HANDLING_UNIT_REFERENCE_INVALID</i>: Reference of handling unit is invalid.</li><li><i>LIMIT_NONPOSITIVE</i>: The LIMIT parameter must be greater than 0 when searching order.</li><li><i>NOT_SUPPORTED_ORDER_TYPE</i>: The type of order is not supported for requested action.</li><li><i>OFFSET_NEGATIVE</i>: The OFFSET parameter cannot be negative when searching order.</li><li><i>ORDER_ALREADY_CANCELED</i>: The order has already been cancelled.</li><li><i>ORDER_DUPLICATED</i>: You cannot create order if an order with the same characteristics already exists.</li><li><i>ORGANIZATION_ACTOR_CODE_INVALID</i>: 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.</li><li><i>ORGANIZATION_NOT_FOUND</i>: A user must belong to an organization to be able to create and manage orders.</li><li><i>R0005</i>: Cannot update information of containers and events.</li><li><i>R0006</i>: Cannot update order if it is in certain status.</li><li><i>R0007</i>: Cannot update container references.</li><li><i>R0008</i>: Cannot cancel the order due to the status is Submitted or InProgress.</li><li><i>R0009</i>: Cannot cancel the order that at least one of its segment is delivered.</li><li><i>SEARCH_DATE_ERROR</i>: Date parameters is invalid when searching order.</li><li><i>UNKNOWN_LOCATION</i>: Location is unknown by MouvONE.</li><li><i>USER_ID_INVALID</i>: User ID is invalid.</li><li><i>WRONG_EVENT_DATE_ORDER</i>: Dates of events must be in chronological order.
              For Import order: LadingImport -&gt; DeliveryImport -&gt; EmptyReleaseImport -&gt; EmptyReturnImport.
              For Export order: EmptyReleaseExport -&gt; PositioningExport -&gt; LadingExport -&gt; DeliveryExport.</li><li><i>WRONG_FORMAT</i>: Order identifier is in wrong format.</li></ul>
- **message** (string | null)
  Error message.


[Powered by Bump.sh](https://bump.sh)