Filter customer orders by given parameters.

GET /customer-orders

Bearer token & Api key

Sample request:

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

Query parameters

transportOrderNumber string

Transport order number.
containerNumber string

Container reference number.
carrierCode string

Carrier code.
processingIndicator string

Processing indicator.

Values are Import, Export, or Transfer.
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.

Values are Draft, Valid, Cancelled, Submitted, Rejected, InProcess, Accepted, or Refused.
offset integer(int32)

Index of the first returned result.

Default value is 0.
limit integer(int32)

Number of results to be returned. Max value is 50.

Default value is 10.
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.

Default value is false.
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.

Default value is false.

Responses

200

text/plain

text/plain application/json text/json

Successful operation.
Hide response attributes Show response attributes 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
  
  Simple projection of CustomerOrder model.
  
  Hide items attributes Show items attributes object
  
  customerOrderId string Required
  
  Customer order identifier.
  
  Minimum length is 1.
  
  date string(date-time) Required
  
  Date of the customer order.
  
  ISO 8601 Extended Format
  
  type string Required
  
  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.
  
  Values are Master, Elementary, SegmentTerminalEntrepot, SegmentEntrepotDepot, SegmentDepotEntrepot, SegmentEntrepotTerminal, or SegmentTransfer.
  
  clientReference string | null
  
  Reference of customer order.
  
  Minimum length is 0, maximum length is 255.
  
  transportOrderNumber string Required
  
  Number of transport order.
  
  Minimum length is 0, maximum length is 256.
  
  status string Required
  
  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 S'mouv 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.
  
  Values are Draft, Valid, Cancelled, Submitted, Rejected, InProcess, Accepted, or Refused.
  
  contractor object Required
  
  Actor information.
  
  Additional properties are NOT allowed.
  
  Hide contractor attributes Show contractor attributes object
  
  code string | null
  
  Actor code.
  
  Detailed information is available in the API Referential.
  
  Maximum length is 32.
  
  name string | null
  
  Actor name.
  
  Maximum length is 256.
  
  company object
  
  Company information.
  
  Additional properties are NOT allowed.
  
  Hide company attributes Show company attributes object
  
  name string | null
  
  Name of the agency.
  
  Maximum length is 64.
  
  location object
  
  Location information.
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  address string | null
  
  Address of the location.
  
  Maximum length is 256.
  
  zipCode string | null
  
  Post code of the location.
  
  Maximum length is 256.
  
  city string | null
  
  City name.
  
  Maximum length is 64.
  
  country string | null
  
  ISO 3166-1 alpha-2 code of country .
  
  Minimum length is 2, maximum length is 2.
  
  contact object
  
  Contact information.
  
  Additional properties are NOT allowed.
  
  Hide contact attributes Show contact attributes object
  
  name string | null
  
  Name of the contact (person, department,...).
  
  Maximum length is 255.
  
  email string | null
  
  Email address.
  
  Maximum length is 255.
  
  phone string | null
  
  Phone number.
  
  Maximum length is 255.
  
  carrier object Required
  
  Actor information.
  
  Additional properties are NOT allowed.
  
  Hide carrier attributes Show carrier attributes object
  
  code string | null
  
  Actor code.
  
  Detailed information is available in the API Referential.
  
  Maximum length is 32.
  
  name string | null
  
  Actor name.
  
  Maximum length is 256.
  
  company object
  
  Company information.
  
  Additional properties are NOT allowed.
  
  Hide company attributes Show company attributes object
  
  name string | null
  
  Name of the agency.
  
  Maximum length is 64.
  
  location object
  
  Location information.
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  address string | null
  
  Address of the location.
  
  Maximum length is 256.
  
  zipCode string | null
  
  Post code of the location.
  
  Maximum length is 256.
  
  city string | null
  
  City name.
  
  Maximum length is 64.
  
  country string | null
  
  ISO 3166-1 alpha-2 code of country .
  
  Minimum length is 2, maximum length is 2.
  
  contact object
  
  Contact information.
  
  Additional properties are NOT allowed.
  
  Hide contact attributes Show contact attributes object
  
  name string | null
  
  Name of the contact (person, department,...).
  
  Maximum length is 255.
  
  email string | null
  
  Email address.
  
  Maximum length is 255.
  
  phone string | null
  
  Phone number.
  
  Maximum length is 255.
  
  customsFlag string Required
  
  Type of flows:
  Import: Import flow.
  Export: Export flow.
  Transfer: Transfer flow.
  
  Values are Import, Export, or Transfer.
Hide response attributes Show response attributes 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
  
  Simple projection of CustomerOrder model.
  
  Hide items attributes Show items attributes object
  
  customerOrderId string Required
  
  Customer order identifier.
  
  Minimum length is 1.
  
  date string(date-time) Required
  
  Date of the customer order.
  
  ISO 8601 Extended Format
  
  type string Required
  
  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.
  
  Values are Master, Elementary, SegmentTerminalEntrepot, SegmentEntrepotDepot, SegmentDepotEntrepot, SegmentEntrepotTerminal, or SegmentTransfer.
  
  clientReference string | null
  
  Reference of customer order.
  
  Minimum length is 0, maximum length is 255.
  
  transportOrderNumber string Required
  
  Number of transport order.
  
  Minimum length is 0, maximum length is 256.
  
  status string Required
  
  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 S'mouv 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.
  
  Values are Draft, Valid, Cancelled, Submitted, Rejected, InProcess, Accepted, or Refused.
  
  contractor object Required
  
  Actor information.
  
  Additional properties are NOT allowed.
  
  Hide contractor attributes Show contractor attributes object
  
  code string | null
  
  Actor code.
  
  Detailed information is available in the API Referential.
  
  Maximum length is 32.
  
  name string | null
  
  Actor name.
  
  Maximum length is 256.
  
  company object
  
  Company information.
  
  Additional properties are NOT allowed.
  
  Hide company attributes Show company attributes object
  
  name string | null
  
  Name of the agency.
  
  Maximum length is 64.
  
  location object
  
  Location information.
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  address string | null
  
  Address of the location.
  
  Maximum length is 256.
  
  zipCode string | null
  
  Post code of the location.
  
  Maximum length is 256.
  
  city string | null
  
  City name.
  
  Maximum length is 64.
  
  country string | null
  
  ISO 3166-1 alpha-2 code of country .
  
  Minimum length is 2, maximum length is 2.
  
  contact object
  
  Contact information.
  
  Additional properties are NOT allowed.
  
  Hide contact attributes Show contact attributes object
  
  name string | null
  
  Name of the contact (person, department,...).
  
  Maximum length is 255.
  
  email string | null
  
  Email address.
  
  Maximum length is 255.
  
  phone string | null
  
  Phone number.
  
  Maximum length is 255.
  
  carrier object Required
  
  Actor information.
  
  Additional properties are NOT allowed.
  
  Hide carrier attributes Show carrier attributes object
  
  code string | null
  
  Actor code.
  
  Detailed information is available in the API Referential.
  
  Maximum length is 32.
  
  name string | null
  
  Actor name.
  
  Maximum length is 256.
  
  company object
  
  Company information.
  
  Additional properties are NOT allowed.
  
  Hide company attributes Show company attributes object
  
  name string | null
  
  Name of the agency.
  
  Maximum length is 64.
  
  location object
  
  Location information.
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  address string | null
  
  Address of the location.
  
  Maximum length is 256.
  
  zipCode string | null
  
  Post code of the location.
  
  Maximum length is 256.
  
  city string | null
  
  City name.
  
  Maximum length is 64.
  
  country string | null
  
  ISO 3166-1 alpha-2 code of country .
  
  Minimum length is 2, maximum length is 2.
  
  contact object
  
  Contact information.
  
  Additional properties are NOT allowed.
  
  Hide contact attributes Show contact attributes object
  
  name string | null
  
  Name of the contact (person, department,...).
  
  Maximum length is 255.
  
  email string | null
  
  Email address.
  
  Maximum length is 255.
  
  phone string | null
  
  Phone number.
  
  Maximum length is 255.
  
  customsFlag string Required
  
  Type of flows:
  Import: Import flow.
  Export: Export flow.
  Transfer: Transfer flow.
  
  Values are Import, Export, or Transfer.
Hide response attributes Show response attributes 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
  
  Simple projection of CustomerOrder model.
  
  Hide items attributes Show items attributes object
  
  customerOrderId string Required
  
  Customer order identifier.
  
  Minimum length is 1.
  
  date string(date-time) Required
  
  Date of the customer order.
  
  ISO 8601 Extended Format
  
  type string Required
  
  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.
  
  Values are Master, Elementary, SegmentTerminalEntrepot, SegmentEntrepotDepot, SegmentDepotEntrepot, SegmentEntrepotTerminal, or SegmentTransfer.
  
  clientReference string | null
  
  Reference of customer order.
  
  Minimum length is 0, maximum length is 255.
  
  transportOrderNumber string Required
  
  Number of transport order.
  
  Minimum length is 0, maximum length is 256.
  
  status string Required
  
  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 S'mouv 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.
  
  Values are Draft, Valid, Cancelled, Submitted, Rejected, InProcess, Accepted, or Refused.
  
  contractor object Required
  
  Actor information.
  
  Additional properties are NOT allowed.
  
  Hide contractor attributes Show contractor attributes object
  
  code string | null
  
  Actor code.
  
  Detailed information is available in the API Referential.
  
  Maximum length is 32.
  
  name string | null
  
  Actor name.
  
  Maximum length is 256.
  
  company object
  
  Company information.
  
  Additional properties are NOT allowed.
  
  Hide company attributes Show company attributes object
  
  name string | null
  
  Name of the agency.
  
  Maximum length is 64.
  
  location object
  
  Location information.
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  address string | null
  
  Address of the location.
  
  Maximum length is 256.
  
  zipCode string | null
  
  Post code of the location.
  
  Maximum length is 256.
  
  city string | null
  
  City name.
  
  Maximum length is 64.
  
  country string | null
  
  ISO 3166-1 alpha-2 code of country .
  
  Minimum length is 2, maximum length is 2.
  
  contact object
  
  Contact information.
  
  Additional properties are NOT allowed.
  
  Hide contact attributes Show contact attributes object
  
  name string | null
  
  Name of the contact (person, department,...).
  
  Maximum length is 255.
  
  email string | null
  
  Email address.
  
  Maximum length is 255.
  
  phone string | null
  
  Phone number.
  
  Maximum length is 255.
  
  carrier object Required
  
  Actor information.
  
  Additional properties are NOT allowed.
  
  Hide carrier attributes Show carrier attributes object
  
  code string | null
  
  Actor code.
  
  Detailed information is available in the API Referential.
  
  Maximum length is 32.
  
  name string | null
  
  Actor name.
  
  Maximum length is 256.
  
  company object
  
  Company information.
  
  Additional properties are NOT allowed.
  
  Hide company attributes Show company attributes object
  
  name string | null
  
  Name of the agency.
  
  Maximum length is 64.
  
  location object
  
  Location information.
  
  Additional properties are NOT allowed.
  
  Hide location attributes Show location attributes object
  
  address string | null
  
  Address of the location.
  
  Maximum length is 256.
  
  zipCode string | null
  
  Post code of the location.
  
  Maximum length is 256.
  
  city string | null
  
  City name.
  
  Maximum length is 64.
  
  country string | null
  
  ISO 3166-1 alpha-2 code of country .
  
  Minimum length is 2, maximum length is 2.
  
  contact object
  
  Contact information.
  
  Additional properties are NOT allowed.
  
  Hide contact attributes Show contact attributes object
  
  name string | null
  
  Name of the contact (person, department,...).
  
  Maximum length is 255.
  
  email string | null
  
  Email address.
  
  Maximum length is 255.
  
  phone string | null
  
  Phone number.
  
  Maximum length is 255.
  
  customsFlag string Required
  
  Type of flows:
  Import: Import flow.
  Export: Export flow.
  Transfer: Transfer flow.
  
  Values are Import, Export, or Transfer.
400

text/plain

text/plain application/json text/json

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.

GET /customer-orders

curl \
 --request GET 'https://soget-api-integration.azure-api.net/customer-orders/v1/customer-orders' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Ocp-Apim-Subscription-Key: $API_KEY"

Response examples (200)

{
  "total": 10,
  "returned": 1,
  "first": 0,
  "items": [
    {
      "customerOrderId": "CDE0000000002",
      "date": "2022-03-02T18:00:00+00:00",
      "type": "Master",
      "clientReference": "FLASD421312",
      "transportOrderNumber": "string",
      "status": "Draft",
      "contractor": {
        "code": "SOGETS.",
        "name": "SOGET SA",
        "company": {
          "name": "ABC Logistics",
          "location": {
            "address": "Terre-Plein de la Barre B.P. 1413 Le Havre",
            "zipCode": "76600",
            "city": "Le Havre",
            "country": "FR"
          }
        },
        "contact": {
          "name": "SA Soget",
          "email": "hello@soget.fr",
          "phone": "0235123456"
        }
      },
      "carrier": {
        "code": "SOGETS.",
        "name": "SOGET SA",
        "company": {
          "name": "ABC Logistics",
          "location": {
            "address": "Terre-Plein de la Barre B.P. 1413 Le Havre",
            "zipCode": "76600",
            "city": "Le Havre",
            "country": "FR"
          }
        },
        "contact": {
          "name": "SA Soget",
          "email": "hello@soget.fr",
          "phone": "0235123456"
        }
      },
      "customsFlag": "Import"
    }
  ]
}

Response examples (200)

{
  "total": 10,
  "returned": 1,
  "first": 0,
  "items": [
    {
      "customerOrderId": "CDE0000000002",
      "date": "2022-03-02T18:00:00+00:00",
      "type": "Master",
      "clientReference": "FLASD421312",
      "transportOrderNumber": "string",
      "status": "Draft",
      "contractor": {
        "code": "SOGETS.",
        "name": "SOGET SA",
        "company": {
          "name": "ABC Logistics",
          "location": {
            "address": "Terre-Plein de la Barre B.P. 1413 Le Havre",
            "zipCode": "76600",
            "city": "Le Havre",
            "country": "FR"
          }
        },
        "contact": {
          "name": "SA Soget",
          "email": "hello@soget.fr",
          "phone": "0235123456"
        }
      },
      "carrier": {
        "code": "SOGETS.",
        "name": "SOGET SA",
        "company": {
          "name": "ABC Logistics",
          "location": {
            "address": "Terre-Plein de la Barre B.P. 1413 Le Havre",
            "zipCode": "76600",
            "city": "Le Havre",
            "country": "FR"
          }
        },
        "contact": {
          "name": "SA Soget",
          "email": "hello@soget.fr",
          "phone": "0235123456"
        }
      },
      "customsFlag": "Import"
    }
  ]
}

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!"
}