Smouv

Update an existing customer order.

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

Sample request:

PUT /customer-orders/CDE0000000001

Headers

  • If-Match string Required

    ETag value to determine resource version.

Path parameters

  • orderId string Required

    Customer order identifier

Body

Information of customer order

  • containers array[object] Required

    Container

    Container base payload.

    At least 1 element.

    Hide containers attributes Show containers attributes object
    • goods array[object] | null

      Goods

      Class contains information about goods.

      Hide goods attributes Show goods attributes object
      • goodsId integer(int32)

        Identify of good.

      • description string | null

        Goods description.

        Maximum length is 264.

      • type string | null

        Packaging code (UNCL code standard).

        Detailed information is available in the API Referential.

        Maximum length is 4.

      • quantity integer(int32) | null

        Number of packages.

      • weight number(double) | null

        Weight of goods (unit in KGM).

      • volume number(double) | null

        Volume of goods.

      • hazardousClasses array[object] | null

        List of hazardous classes.

        Hazardous class information.

        Hide hazardousClasses attributes Show hazardousClasses attributes object
        • imdgCode string | null

          IMDG code.

          Maximum length is 11.

        • undgCode string | null

          UNDG code.

          Maximum length is 11.

        • packagingGroup string | null

          Packaging group.

          Maximum length is 11.

    • reference string | null

      Container number. It's mandatory for import and transfer flow. A container number must follow the ISO 6346:1995.

    • type string | null

      Size type. It's mandatory for export flow.

      Detailed information is available in the API Referential.

      Minimum length is 4, maximum length is 4.

    • grossWeight number(double) | null

      Gross weight of container (unit in KGM).

    • tare number(double) | null

      Weight of empty container (unit in KGM).

    • sealNumbers array[string] | null

      List of seal numbers of container.

    • indicator object

      Indicators information.

      Additional properties are NOT allowed.

      Hide indicator attributes Show indicator attributes object
      • isReefer boolean | null

        Reefer indicator.

        Default value: false.

      • isHazardous boolean | null

        Hazardous indicator.

        Default value: false.

      • isOog boolean | null

        Out of gauge indicator.

        Default value: false.

    • customsInformation string | null

      Customs information.

      Maximum length is 64.

    • comment string | null

      Comment about the container.

      Maximum length is 1024.

    • reefer object

      Class contains refrigeration information.

      Additional properties are NOT allowed.

      Hide reefer attribute Show reefer attribute object
      • setPoint number(double) | null

        Setpoint temperature, indicated by the contractor.

    • oog object

      Class contains out of gauge information.

      Additional properties are NOT allowed.

      Hide oog attributes Show oog attributes object
      • length number(double) | null

        Excess length (unit in M).

      • width number(double) | null

        Excess width (unit in M).

      • height number(double) | null

        Excess height (unit in M).

    • billOfLading string | null

      Bill of lading. It's available for import and transfer flow.

      Maximum length is 256.

    • bookingNumber string | null

      Booking reference. It's mandatory for export flow. Available for export and transfer flow.

      Maximum length is 256.

    • events array[object] | null Required

      List of events (must contains exactly 4 events with import/ export order and 2 events with transfer order)

      List of mandatory events when creating an export order:

      • EmptyReleaseExport: Empty container made available.
      • PositioningExport: Empty container positioned.
      • LadingExport: Full container export handled.
      • DeliveryExport: Full export container delivered.

      List of mandatory events when creating an import order:

      • LadingImport: Full container import handled.
      • DeliveryImport: Full container import delivered.
      • EmptyReleaseImport: Empty container recovered.
      • EmptyReturnImport: Empty container returned.

      List of mandatory events when creating a transfer order:

      • LadingTransfer: Full container handled.
      • DeliveryTransfer: Full container delivered.

      Event payload when post or put a customer order.

      Hide events attributes Show events attributes object
      • type string Required

        List of mandatory events when exporting an order:

        • EmptyReleaseExport: Empty container made available.
        • PositioningExport: Empty container positioned.
        • LadingExport: Full container export handled.
        • DeliveryExport: Full export container delivered.

        List of mandatory events when importing an order:

        • LadingImport: Full container import handled.
        • DeliveryImport: Full container import delivered.
        • EmptyReleaseImport: Empty container recovered.
        • EmptyReturnImport: Empty container returned.

        List of mandatory events for the Transfer order:

        • LadingTransfer: Full container handled.
        • DeliveryTransfer: Full container delivered.

        The other events are related to the interconnection between S’mouv and the PCS S)ONE (Announced, CarrierIdentification, ...).

        Values are Announced, CarrierIdentification, LadingImport, DeliveryImport, EmptyReleaseImport, EmptyReturnImport, EmptyReleaseExport, PositioningExport, LadingExport, DeliveryExport, Association, TokenCodeTrucker, CancelCarrierIdentification, UpdateAssociation, AnnouncementCancelled, LadingTransfer, or DeliveryTransfer.

      • startDate string(date-time) | null

        Date where the event starts.

        It's mandatory for the delivery in import, positioning of the empty container in export, and delivery in transfer.

        ISO 8601 Extended Format

      • endDate string(date-time) | null

        Date where the event ends.

        ISO 8601 Extended Format

      • creationDate string(date-time) | null

        Date of event creation / Completion date for OK event.

        ISO 8601 Extended Format

      • location object Required

        Class contains information about location where an event occurs.

        Additional properties are NOT allowed.

        Hide location attributes Show location attributes object
        • code string | null

          Location code.

          Detailed information is available in the API Referential.

          Maximum length is 20.

        • name string | null

          Location name.

          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.

        • reference string | null

          Given reference during the event.

          Maximum length is 64.

  • 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.

    Maximum length is 256.

  • clientReference string | null

    Importer/Exporter reference.

    Maximum length is 256.

  • customsFlag string Required

    Type of flows:

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

    Values are Import, Export, or Transfer.

  • priceInformation string | null

    Comment about pricing.

    Maximum length is 1024.

  • instructionsInformation string | null

    Instructions for the driver.

    Maximum length is 1024.

  • contractTermsInformation string | null

    Information about the contract terms.

    Maximum length is 1024.

  • comment string | null

    General comments about the transport order.

    Maximum length is 1024.

  • voyage object

    Voyage information.

    Additional properties are NOT allowed.

    Hide voyage attributes Show voyage attributes object
    • meansName string | null

      Transport means name.

      Maximum length is 384.

    • freightAgent string | null

      Freight agent.

      Maximum length is 256.

    • shippingCompany string | null

      Shipping company name.

      Maximum length is 256.

    • eta string(date-time) | null

      Estimated time of arrival: available for import and transfer flow.

      ISO 8601 Extended Format

    • etd string(date-time) | null

      Estimated date of departure: available for the export flow.

      ISO 8601 Extended Format

    • closingCustoms string(date-time) | null

      Customs closing date: available for the export flow.

      ISO 8601 Extended Format

    • closingDangerous string(date-time) | null

      Dangerous closing date: available for the export flow

      ISO 8601 Extended Format

    • closingDelivery string(date-time) | null

      Delivery closing date: available for the export flow.

      ISO 8601 Extended Format

Body

Information of customer order

  • containers array[object] Required

    Container

    Container base payload.

    At least 1 element.

    Hide containers attributes Show containers attributes object
    • goods array[object] | null

      Goods

      Class contains information about goods.

      Hide goods attributes Show goods attributes object
      • goodsId integer(int32)

        Identify of good.

      • description string | null

        Goods description.

        Maximum length is 264.

      • type string | null

        Packaging code (UNCL code standard).

        Detailed information is available in the API Referential.

        Maximum length is 4.

      • quantity integer(int32) | null

        Number of packages.

      • weight number(double) | null

        Weight of goods (unit in KGM).

      • volume number(double) | null

        Volume of goods.

      • hazardousClasses array[object] | null

        List of hazardous classes.

        Hazardous class information.

        Hide hazardousClasses attributes Show hazardousClasses attributes object
        • imdgCode string | null

          IMDG code.

          Maximum length is 11.

        • undgCode string | null

          UNDG code.

          Maximum length is 11.

        • packagingGroup string | null

          Packaging group.

          Maximum length is 11.

    • reference string | null

      Container number. It's mandatory for import and transfer flow. A container number must follow the ISO 6346:1995.

    • type string | null

      Size type. It's mandatory for export flow.

      Detailed information is available in the API Referential.

      Minimum length is 4, maximum length is 4.

    • grossWeight number(double) | null

      Gross weight of container (unit in KGM).

    • tare number(double) | null

      Weight of empty container (unit in KGM).

    • sealNumbers array[string] | null

      List of seal numbers of container.

    • indicator object

      Indicators information.

      Additional properties are NOT allowed.

      Hide indicator attributes Show indicator attributes object
      • isReefer boolean | null

        Reefer indicator.

        Default value: false.

      • isHazardous boolean | null

        Hazardous indicator.

        Default value: false.

      • isOog boolean | null

        Out of gauge indicator.

        Default value: false.

    • customsInformation string | null

      Customs information.

      Maximum length is 64.

    • comment string | null

      Comment about the container.

      Maximum length is 1024.

    • reefer object

      Class contains refrigeration information.

      Additional properties are NOT allowed.

      Hide reefer attribute Show reefer attribute object
      • setPoint number(double) | null

        Setpoint temperature, indicated by the contractor.

    • oog object

      Class contains out of gauge information.

      Additional properties are NOT allowed.

      Hide oog attributes Show oog attributes object
      • length number(double) | null

        Excess length (unit in M).

      • width number(double) | null

        Excess width (unit in M).

      • height number(double) | null

        Excess height (unit in M).

    • billOfLading string | null

      Bill of lading. It's available for import and transfer flow.

      Maximum length is 256.

    • bookingNumber string | null

      Booking reference. It's mandatory for export flow. Available for export and transfer flow.

      Maximum length is 256.

    • events array[object] | null Required

      List of events (must contains exactly 4 events with import/ export order and 2 events with transfer order)

      List of mandatory events when creating an export order:

      • EmptyReleaseExport: Empty container made available.
      • PositioningExport: Empty container positioned.
      • LadingExport: Full container export handled.
      • DeliveryExport: Full export container delivered.

      List of mandatory events when creating an import order:

      • LadingImport: Full container import handled.
      • DeliveryImport: Full container import delivered.
      • EmptyReleaseImport: Empty container recovered.
      • EmptyReturnImport: Empty container returned.

      List of mandatory events when creating a transfer order:

      • LadingTransfer: Full container handled.
      • DeliveryTransfer: Full container delivered.

      Event payload when post or put a customer order.

      Hide events attributes Show events attributes object
      • type string Required

        List of mandatory events when exporting an order:

        • EmptyReleaseExport: Empty container made available.
        • PositioningExport: Empty container positioned.
        • LadingExport: Full container export handled.
        • DeliveryExport: Full export container delivered.

        List of mandatory events when importing an order:

        • LadingImport: Full container import handled.
        • DeliveryImport: Full container import delivered.
        • EmptyReleaseImport: Empty container recovered.
        • EmptyReturnImport: Empty container returned.

        List of mandatory events for the Transfer order:

        • LadingTransfer: Full container handled.
        • DeliveryTransfer: Full container delivered.

        The other events are related to the interconnection between S’mouv and the PCS S)ONE (Announced, CarrierIdentification, ...).

        Values are Announced, CarrierIdentification, LadingImport, DeliveryImport, EmptyReleaseImport, EmptyReturnImport, EmptyReleaseExport, PositioningExport, LadingExport, DeliveryExport, Association, TokenCodeTrucker, CancelCarrierIdentification, UpdateAssociation, AnnouncementCancelled, LadingTransfer, or DeliveryTransfer.

      • startDate string(date-time) | null

        Date where the event starts.

        It's mandatory for the delivery in import, positioning of the empty container in export, and delivery in transfer.

        ISO 8601 Extended Format

      • endDate string(date-time) | null

        Date where the event ends.

        ISO 8601 Extended Format

      • creationDate string(date-time) | null

        Date of event creation / Completion date for OK event.

        ISO 8601 Extended Format

      • location object Required

        Class contains information about location where an event occurs.

        Additional properties are NOT allowed.

        Hide location attributes Show location attributes object
        • code string | null

          Location code.

          Detailed information is available in the API Referential.

          Maximum length is 20.

        • name string | null

          Location name.

          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.

        • reference string | null

          Given reference during the event.

          Maximum length is 64.

  • 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.

    Maximum length is 256.

  • clientReference string | null

    Importer/Exporter reference.

    Maximum length is 256.

  • customsFlag string Required

    Type of flows:

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

    Values are Import, Export, or Transfer.

  • priceInformation string | null

    Comment about pricing.

    Maximum length is 1024.

  • instructionsInformation string | null

    Instructions for the driver.

    Maximum length is 1024.

  • contractTermsInformation string | null

    Information about the contract terms.

    Maximum length is 1024.

  • comment string | null

    General comments about the transport order.

    Maximum length is 1024.

  • voyage object

    Voyage information.

    Additional properties are NOT allowed.

    Hide voyage attributes Show voyage attributes object
    • meansName string | null

      Transport means name.

      Maximum length is 384.

    • freightAgent string | null

      Freight agent.

      Maximum length is 256.

    • shippingCompany string | null

      Shipping company name.

      Maximum length is 256.

    • eta string(date-time) | null

      Estimated time of arrival: available for import and transfer flow.

      ISO 8601 Extended Format

    • etd string(date-time) | null

      Estimated date of departure: available for the export flow.

      ISO 8601 Extended Format

    • closingCustoms string(date-time) | null

      Customs closing date: available for the export flow.

      ISO 8601 Extended Format

    • closingDangerous string(date-time) | null

      Dangerous closing date: available for the export flow

      ISO 8601 Extended Format

    • closingDelivery string(date-time) | null

      Delivery closing date: available for the export flow.

      ISO 8601 Extended Format

Body

Information of customer order

  • containers array[object] Required

    Container

    Container base payload.

    At least 1 element.

    Hide containers attributes Show containers attributes object
    • goods array[object] | null

      Goods

      Class contains information about goods.

      Hide goods attributes Show goods attributes object
      • goodsId integer(int32)

        Identify of good.

      • description string | null

        Goods description.

        Maximum length is 264.

      • type string | null

        Packaging code (UNCL code standard).

        Detailed information is available in the API Referential.

        Maximum length is 4.

      • quantity integer(int32) | null

        Number of packages.

      • weight number(double) | null

        Weight of goods (unit in KGM).

      • volume number(double) | null

        Volume of goods.

      • hazardousClasses array[object] | null

        List of hazardous classes.

        Hazardous class information.

        Hide hazardousClasses attributes Show hazardousClasses attributes object
        • imdgCode string | null

          IMDG code.

          Maximum length is 11.

        • undgCode string | null

          UNDG code.

          Maximum length is 11.

        • packagingGroup string | null

          Packaging group.

          Maximum length is 11.

    • reference string | null

      Container number. It's mandatory for import and transfer flow. A container number must follow the ISO 6346:1995.

    • type string | null

      Size type. It's mandatory for export flow.

      Detailed information is available in the API Referential.

      Minimum length is 4, maximum length is 4.

    • grossWeight number(double) | null

      Gross weight of container (unit in KGM).

    • tare number(double) | null

      Weight of empty container (unit in KGM).

    • sealNumbers array[string] | null

      List of seal numbers of container.

    • indicator object

      Indicators information.

      Additional properties are NOT allowed.

      Hide indicator attributes Show indicator attributes object
      • isReefer boolean | null

        Reefer indicator.

        Default value: false.

      • isHazardous boolean | null

        Hazardous indicator.

        Default value: false.

      • isOog boolean | null

        Out of gauge indicator.

        Default value: false.

    • customsInformation string | null

      Customs information.

      Maximum length is 64.

    • comment string | null

      Comment about the container.

      Maximum length is 1024.

    • reefer object

      Class contains refrigeration information.

      Additional properties are NOT allowed.

      Hide reefer attribute Show reefer attribute object
      • setPoint number(double) | null

        Setpoint temperature, indicated by the contractor.

    • oog object

      Class contains out of gauge information.

      Additional properties are NOT allowed.

      Hide oog attributes Show oog attributes object
      • length number(double) | null

        Excess length (unit in M).

      • width number(double) | null

        Excess width (unit in M).

      • height number(double) | null

        Excess height (unit in M).

    • billOfLading string | null

      Bill of lading. It's available for import and transfer flow.

      Maximum length is 256.

    • bookingNumber string | null

      Booking reference. It's mandatory for export flow. Available for export and transfer flow.

      Maximum length is 256.

    • events array[object] | null Required

      List of events (must contains exactly 4 events with import/ export order and 2 events with transfer order)

      List of mandatory events when creating an export order:

      • EmptyReleaseExport: Empty container made available.
      • PositioningExport: Empty container positioned.
      • LadingExport: Full container export handled.
      • DeliveryExport: Full export container delivered.

      List of mandatory events when creating an import order:

      • LadingImport: Full container import handled.
      • DeliveryImport: Full container import delivered.
      • EmptyReleaseImport: Empty container recovered.
      • EmptyReturnImport: Empty container returned.

      List of mandatory events when creating a transfer order:

      • LadingTransfer: Full container handled.
      • DeliveryTransfer: Full container delivered.

      Event payload when post or put a customer order.

      Hide events attributes Show events attributes object
      • type string Required

        List of mandatory events when exporting an order:

        • EmptyReleaseExport: Empty container made available.
        • PositioningExport: Empty container positioned.
        • LadingExport: Full container export handled.
        • DeliveryExport: Full export container delivered.

        List of mandatory events when importing an order:

        • LadingImport: Full container import handled.
        • DeliveryImport: Full container import delivered.
        • EmptyReleaseImport: Empty container recovered.
        • EmptyReturnImport: Empty container returned.

        List of mandatory events for the Transfer order:

        • LadingTransfer: Full container handled.
        • DeliveryTransfer: Full container delivered.

        The other events are related to the interconnection between S’mouv and the PCS S)ONE (Announced, CarrierIdentification, ...).

        Values are Announced, CarrierIdentification, LadingImport, DeliveryImport, EmptyReleaseImport, EmptyReturnImport, EmptyReleaseExport, PositioningExport, LadingExport, DeliveryExport, Association, TokenCodeTrucker, CancelCarrierIdentification, UpdateAssociation, AnnouncementCancelled, LadingTransfer, or DeliveryTransfer.

      • startDate string(date-time) | null

        Date where the event starts.

        It's mandatory for the delivery in import, positioning of the empty container in export, and delivery in transfer.

        ISO 8601 Extended Format

      • endDate string(date-time) | null

        Date where the event ends.

        ISO 8601 Extended Format

      • creationDate string(date-time) | null

        Date of event creation / Completion date for OK event.

        ISO 8601 Extended Format

      • location object Required

        Class contains information about location where an event occurs.

        Additional properties are NOT allowed.

        Hide location attributes Show location attributes object
        • code string | null

          Location code.

          Detailed information is available in the API Referential.

          Maximum length is 20.

        • name string | null

          Location name.

          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.

        • reference string | null

          Given reference during the event.

          Maximum length is 64.

  • 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.

    Maximum length is 256.

  • clientReference string | null

    Importer/Exporter reference.

    Maximum length is 256.

  • customsFlag string Required

    Type of flows:

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

    Values are Import, Export, or Transfer.

  • priceInformation string | null

    Comment about pricing.

    Maximum length is 1024.

  • instructionsInformation string | null

    Instructions for the driver.

    Maximum length is 1024.

  • contractTermsInformation string | null

    Information about the contract terms.

    Maximum length is 1024.

  • comment string | null

    General comments about the transport order.

    Maximum length is 1024.

  • voyage object

    Voyage information.

    Additional properties are NOT allowed.

    Hide voyage attributes Show voyage attributes object
    • meansName string | null

      Transport means name.

      Maximum length is 384.

    • freightAgent string | null

      Freight agent.

      Maximum length is 256.

    • shippingCompany string | null

      Shipping company name.

      Maximum length is 256.

    • eta string(date-time) | null

      Estimated time of arrival: available for import and transfer flow.

      ISO 8601 Extended Format

    • etd string(date-time) | null

      Estimated date of departure: available for the export flow.

      ISO 8601 Extended Format

    • closingCustoms string(date-time) | null

      Customs closing date: available for the export flow.

      ISO 8601 Extended Format

    • closingDangerous string(date-time) | null

      Dangerous closing date: available for the export flow

      ISO 8601 Extended Format

    • closingDelivery string(date-time) | null

      Delivery closing date: available for the export flow.

      ISO 8601 Extended Format

Body

Information of customer order

  • containers array[object] Required

    Container

    Container base payload.

    At least 1 element.

    Hide containers attributes Show containers attributes object
    • goods array[object] | null

      Goods

      Class contains information about goods.

      Hide goods attributes Show goods attributes object
      • goodsId integer(int32)

        Identify of good.

      • description string | null

        Goods description.

        Maximum length is 264.

      • type string | null

        Packaging code (UNCL code standard).

        Detailed information is available in the API Referential.

        Maximum length is 4.

      • quantity integer(int32) | null

        Number of packages.

      • weight number(double) | null

        Weight of goods (unit in KGM).

      • volume number(double) | null

        Volume of goods.

      • hazardousClasses array[object] | null

        List of hazardous classes.

        Hazardous class information.

        Hide hazardousClasses attributes Show hazardousClasses attributes object
        • imdgCode string | null

          IMDG code.

          Maximum length is 11.

        • undgCode string | null

          UNDG code.

          Maximum length is 11.

        • packagingGroup string | null

          Packaging group.

          Maximum length is 11.

    • reference string | null

      Container number. It's mandatory for import and transfer flow. A container number must follow the ISO 6346:1995.

    • type string | null

      Size type. It's mandatory for export flow.

      Detailed information is available in the API Referential.

      Minimum length is 4, maximum length is 4.

    • grossWeight number(double) | null

      Gross weight of container (unit in KGM).

    • tare number(double) | null

      Weight of empty container (unit in KGM).

    • sealNumbers array[string] | null

      List of seal numbers of container.

    • indicator object

      Indicators information.

      Additional properties are NOT allowed.

      Hide indicator attributes Show indicator attributes object
      • isReefer boolean | null

        Reefer indicator.

        Default value: false.

      • isHazardous boolean | null

        Hazardous indicator.

        Default value: false.

      • isOog boolean | null

        Out of gauge indicator.

        Default value: false.

    • customsInformation string | null

      Customs information.

      Maximum length is 64.

    • comment string | null

      Comment about the container.

      Maximum length is 1024.

    • reefer object

      Class contains refrigeration information.

      Additional properties are NOT allowed.

      Hide reefer attribute Show reefer attribute object
      • setPoint number(double) | null

        Setpoint temperature, indicated by the contractor.

    • oog object

      Class contains out of gauge information.

      Additional properties are NOT allowed.

      Hide oog attributes Show oog attributes object
      • length number(double) | null

        Excess length (unit in M).

      • width number(double) | null

        Excess width (unit in M).

      • height number(double) | null

        Excess height (unit in M).

    • billOfLading string | null

      Bill of lading. It's available for import and transfer flow.

      Maximum length is 256.

    • bookingNumber string | null

      Booking reference. It's mandatory for export flow. Available for export and transfer flow.

      Maximum length is 256.

    • events array[object] | null Required

      List of events (must contains exactly 4 events with import/ export order and 2 events with transfer order)

      List of mandatory events when creating an export order:

      • EmptyReleaseExport: Empty container made available.
      • PositioningExport: Empty container positioned.
      • LadingExport: Full container export handled.
      • DeliveryExport: Full export container delivered.

      List of mandatory events when creating an import order:

      • LadingImport: Full container import handled.
      • DeliveryImport: Full container import delivered.
      • EmptyReleaseImport: Empty container recovered.
      • EmptyReturnImport: Empty container returned.

      List of mandatory events when creating a transfer order:

      • LadingTransfer: Full container handled.
      • DeliveryTransfer: Full container delivered.

      Event payload when post or put a customer order.

      Hide events attributes Show events attributes object
      • type string Required

        List of mandatory events when exporting an order:

        • EmptyReleaseExport: Empty container made available.
        • PositioningExport: Empty container positioned.
        • LadingExport: Full container export handled.
        • DeliveryExport: Full export container delivered.

        List of mandatory events when importing an order:

        • LadingImport: Full container import handled.
        • DeliveryImport: Full container import delivered.
        • EmptyReleaseImport: Empty container recovered.
        • EmptyReturnImport: Empty container returned.

        List of mandatory events for the Transfer order:

        • LadingTransfer: Full container handled.
        • DeliveryTransfer: Full container delivered.

        The other events are related to the interconnection between S’mouv and the PCS S)ONE (Announced, CarrierIdentification, ...).

        Values are Announced, CarrierIdentification, LadingImport, DeliveryImport, EmptyReleaseImport, EmptyReturnImport, EmptyReleaseExport, PositioningExport, LadingExport, DeliveryExport, Association, TokenCodeTrucker, CancelCarrierIdentification, UpdateAssociation, AnnouncementCancelled, LadingTransfer, or DeliveryTransfer.

      • startDate string(date-time) | null

        Date where the event starts.

        It's mandatory for the delivery in import, positioning of the empty container in export, and delivery in transfer.

        ISO 8601 Extended Format

      • endDate string(date-time) | null

        Date where the event ends.

        ISO 8601 Extended Format

      • creationDate string(date-time) | null

        Date of event creation / Completion date for OK event.

        ISO 8601 Extended Format

      • location object Required

        Class contains information about location where an event occurs.

        Additional properties are NOT allowed.

        Hide location attributes Show location attributes object
        • code string | null

          Location code.

          Detailed information is available in the API Referential.

          Maximum length is 20.

        • name string | null

          Location name.

          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.

        • reference string | null

          Given reference during the event.

          Maximum length is 64.

  • 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.

    Maximum length is 256.

  • clientReference string | null

    Importer/Exporter reference.

    Maximum length is 256.

  • customsFlag string Required

    Type of flows:

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

    Values are Import, Export, or Transfer.

  • priceInformation string | null

    Comment about pricing.

    Maximum length is 1024.

  • instructionsInformation string | null

    Instructions for the driver.

    Maximum length is 1024.

  • contractTermsInformation string | null

    Information about the contract terms.

    Maximum length is 1024.

  • comment string | null

    General comments about the transport order.

    Maximum length is 1024.

  • voyage object

    Voyage information.

    Additional properties are NOT allowed.

    Hide voyage attributes Show voyage attributes object
    • meansName string | null

      Transport means name.

      Maximum length is 384.

    • freightAgent string | null

      Freight agent.

      Maximum length is 256.

    • shippingCompany string | null

      Shipping company name.

      Maximum length is 256.

    • eta string(date-time) | null

      Estimated time of arrival: available for import and transfer flow.

      ISO 8601 Extended Format

    • etd string(date-time) | null

      Estimated date of departure: available for the export flow.

      ISO 8601 Extended Format

    • closingCustoms string(date-time) | null

      Customs closing date: available for the export flow.

      ISO 8601 Extended Format

    • closingDangerous string(date-time) | null

      Dangerous closing date: available for the export flow

      ISO 8601 Extended Format

    • closingDelivery string(date-time) | null

      Delivery closing date: available for the export flow.

      ISO 8601 Extended Format

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.
  • 412

    PreconditionFailed.

    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.
PUT /customer-orders/{orderId} 
curl \
 --request PUT '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" \
 --header "Content-Type: application/json-patch+json" \
 --header "If-Match: string"
curl \
 --request PUT '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" \
 --header "Content-Type: application/json" \
 --header "If-Match: string" \
 --data '{"containers":[{"goods":[{"goodsId":42,"description":"Colorful balloon","type":"BF","quantity":3000000,"weight":100.5,"volume":20.5,"hazardousClasses":[{"imdgCode":"3.1","undgCode":"1001","packagingGroup":"III"}]}],"reference":"CGMU1234567","type":"22G1","grossWeight":2000,"tare":200.5,"sealNumbers":["string"],"indicator":{"isReefer":false,"isHazardous":false,"isOog":false},"customsInformation":"Customs passed at MTDF","comment":"This is a new container","reefer":{"setPoint":14.5},"oog":{"length":5,"width":5,"height":5},"billOfLading":"BOL-12-345-6789","bookingNumber":"BCK-03-03-2022","events":[{"type":"Announced","startDate":"2022-03-02T18:00:00+00:00","endDate":"2022-03-02T23:21:00+00:00","creationDate":"2025-05-04T09:42:00Z","location":{"code":"MTDF","name":"Terminal de France","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"},"reference":"LOC-13-286-182"}}]}],"date":"2022-03-02T18:00:00+00:00","sender":"Dupont Jean","clientReference":"AUCHAN_12_678","customsFlag":"Import","priceInformation":"Let's apply a discount for this order","instructionsInformation":"This order has to be handled fast!","contractTermsInformation":"International terms and conditions","comment":"This is an urgent transport.","voyage":{"meansName":"MSC GORILLA","freightAgent":"CCGM","shippingCompany":"ZIM","eta":"2022-03-02T18:00:00+00:00","etd":"2022-03-02T18:00:00+00:00","closingCustoms":"2022-03-02T18:00:00+00:00","closingDangerous":"2022-03-02T18:00:00+00:00","closingDelivery":"2022-03-02T18:00:00+00:00"}}'
curl \
 --request PUT '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" \
 --header "Content-Type: text/json" \
 --header "If-Match: string"
curl \
 --request PUT '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" \
 --header "Content-Type: application/*+json" \
 --header "If-Match: string"
Request examples 
# Headers
If-Match: string

# Payload
{
  "containers": [
    {
      "goods": [
        {
          "goodsId": 42,
          "description": "Colorful balloon",
          "type": "BF",
          "quantity": 3000000,
          "weight": 100.5,
          "volume": 20.5,
          "hazardousClasses": [
            {
              "imdgCode": "3.1",
              "undgCode": "1001",
              "packagingGroup": "III"
            }
          ]
        }
      ],
      "reference": "CGMU1234567",
      "type": "22G1",
      "grossWeight": 2000,
      "tare": 200.5,
      "sealNumbers": [
        "string"
      ],
      "indicator": {
        "isReefer": false,
        "isHazardous": false,
        "isOog": false
      },
      "customsInformation": "Customs passed at MTDF",
      "comment": "This is a new container",
      "reefer": {
        "setPoint": 14.5
      },
      "oog": {
        "length": 5,
        "width": 5,
        "height": 5
      },
      "billOfLading": "BOL-12-345-6789",
      "bookingNumber": "BCK-03-03-2022",
      "events": [
        {
          "type": "Announced",
          "startDate": "2022-03-02T18:00:00+00:00",
          "endDate": "2022-03-02T23:21:00+00:00",
          "creationDate": "2025-05-04T09:42:00Z",
          "location": {
            "code": "MTDF",
            "name": "Terminal de France",
            "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"
            },
            "reference": "LOC-13-286-182"
          }
        }
      ]
    }
  ],
  "date": "2022-03-02T18:00:00+00:00",
  "sender": "Dupont Jean",
  "clientReference": "AUCHAN_12_678",
  "customsFlag": "Import",
  "priceInformation": "Let's apply a discount for this order",
  "instructionsInformation": "This order has to be handled fast!",
  "contractTermsInformation": "International terms and conditions",
  "comment": "This is an urgent transport.",
  "voyage": {
    "meansName": "MSC GORILLA",
    "freightAgent": "CCGM",
    "shippingCompany": "ZIM",
    "eta": "2022-03-02T18:00:00+00:00",
    "etd": "2022-03-02T18:00:00+00:00",
    "closingCustoms": "2022-03-02T18:00:00+00:00",
    "closingDangerous": "2022-03-02T18:00:00+00:00",
    "closingDelivery": "2022-03-02T18:00:00+00:00"
  }
}
Request examples 
# Headers
If-Match: string

# Payload
{
  "containers": [
    {
      "goods": [
        {
          "goodsId": 42,
          "description": "Colorful balloon",
          "type": "BF",
          "quantity": 3000000,
          "weight": 100.5,
          "volume": 20.5,
          "hazardousClasses": [
            {
              "imdgCode": "3.1",
              "undgCode": "1001",
              "packagingGroup": "III"
            }
          ]
        }
      ],
      "reference": "CGMU1234567",
      "type": "22G1",
      "grossWeight": 2000,
      "tare": 200.5,
      "sealNumbers": [
        "string"
      ],
      "indicator": {
        "isReefer": false,
        "isHazardous": false,
        "isOog": false
      },
      "customsInformation": "Customs passed at MTDF",
      "comment": "This is a new container",
      "reefer": {
        "setPoint": 14.5
      },
      "oog": {
        "length": 5,
        "width": 5,
        "height": 5
      },
      "billOfLading": "BOL-12-345-6789",
      "bookingNumber": "BCK-03-03-2022",
      "events": [
        {
          "type": "Announced",
          "startDate": "2022-03-02T18:00:00+00:00",
          "endDate": "2022-03-02T23:21:00+00:00",
          "creationDate": "2025-05-04T09:42:00Z",
          "location": {
            "code": "MTDF",
            "name": "Terminal de France",
            "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"
            },
            "reference": "LOC-13-286-182"
          }
        }
      ]
    }
  ],
  "date": "2022-03-02T18:00:00+00:00",
  "sender": "Dupont Jean",
  "clientReference": "AUCHAN_12_678",
  "customsFlag": "Import",
  "priceInformation": "Let's apply a discount for this order",
  "instructionsInformation": "This order has to be handled fast!",
  "contractTermsInformation": "International terms and conditions",
  "comment": "This is an urgent transport.",
  "voyage": {
    "meansName": "MSC GORILLA",
    "freightAgent": "CCGM",
    "shippingCompany": "ZIM",
    "eta": "2022-03-02T18:00:00+00:00",
    "etd": "2022-03-02T18:00:00+00:00",
    "closingCustoms": "2022-03-02T18:00:00+00:00",
    "closingDangerous": "2022-03-02T18:00:00+00:00",
    "closingDelivery": "2022-03-02T18:00:00+00:00"
  }
}
Request examples 
# Headers
If-Match: string

# Payload
{
  "containers": [
    {
      "goods": [
        {
          "goodsId": 42,
          "description": "Colorful balloon",
          "type": "BF",
          "quantity": 3000000,
          "weight": 100.5,
          "volume": 20.5,
          "hazardousClasses": [
            {
              "imdgCode": "3.1",
              "undgCode": "1001",
              "packagingGroup": "III"
            }
          ]
        }
      ],
      "reference": "CGMU1234567",
      "type": "22G1",
      "grossWeight": 2000,
      "tare": 200.5,
      "sealNumbers": [
        "string"
      ],
      "indicator": {
        "isReefer": false,
        "isHazardous": false,
        "isOog": false
      },
      "customsInformation": "Customs passed at MTDF",
      "comment": "This is a new container",
      "reefer": {
        "setPoint": 14.5
      },
      "oog": {
        "length": 5,
        "width": 5,
        "height": 5
      },
      "billOfLading": "BOL-12-345-6789",
      "bookingNumber": "BCK-03-03-2022",
      "events": [
        {
          "type": "Announced",
          "startDate": "2022-03-02T18:00:00+00:00",
          "endDate": "2022-03-02T23:21:00+00:00",
          "creationDate": "2025-05-04T09:42:00Z",
          "location": {
            "code": "MTDF",
            "name": "Terminal de France",
            "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"
            },
            "reference": "LOC-13-286-182"
          }
        }
      ]
    }
  ],
  "date": "2022-03-02T18:00:00+00:00",
  "sender": "Dupont Jean",
  "clientReference": "AUCHAN_12_678",
  "customsFlag": "Import",
  "priceInformation": "Let's apply a discount for this order",
  "instructionsInformation": "This order has to be handled fast!",
  "contractTermsInformation": "International terms and conditions",
  "comment": "This is an urgent transport.",
  "voyage": {
    "meansName": "MSC GORILLA",
    "freightAgent": "CCGM",
    "shippingCompany": "ZIM",
    "eta": "2022-03-02T18:00:00+00:00",
    "etd": "2022-03-02T18:00:00+00:00",
    "closingCustoms": "2022-03-02T18:00:00+00:00",
    "closingDangerous": "2022-03-02T18:00:00+00:00",
    "closingDelivery": "2022-03-02T18:00:00+00:00"
  }
}
Request examples 
# Headers
If-Match: string

# Payload
{
  "containers": [
    {
      "goods": [
        {
          "goodsId": 42,
          "description": "Colorful balloon",
          "type": "BF",
          "quantity": 3000000,
          "weight": 100.5,
          "volume": 20.5,
          "hazardousClasses": [
            {
              "imdgCode": "3.1",
              "undgCode": "1001",
              "packagingGroup": "III"
            }
          ]
        }
      ],
      "reference": "CGMU1234567",
      "type": "22G1",
      "grossWeight": 2000,
      "tare": 200.5,
      "sealNumbers": [
        "string"
      ],
      "indicator": {
        "isReefer": false,
        "isHazardous": false,
        "isOog": false
      },
      "customsInformation": "Customs passed at MTDF",
      "comment": "This is a new container",
      "reefer": {
        "setPoint": 14.5
      },
      "oog": {
        "length": 5,
        "width": 5,
        "height": 5
      },
      "billOfLading": "BOL-12-345-6789",
      "bookingNumber": "BCK-03-03-2022",
      "events": [
        {
          "type": "Announced",
          "startDate": "2022-03-02T18:00:00+00:00",
          "endDate": "2022-03-02T23:21:00+00:00",
          "creationDate": "2025-05-04T09:42:00Z",
          "location": {
            "code": "MTDF",
            "name": "Terminal de France",
            "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"
            },
            "reference": "LOC-13-286-182"
          }
        }
      ]
    }
  ],
  "date": "2022-03-02T18:00:00+00:00",
  "sender": "Dupont Jean",
  "clientReference": "AUCHAN_12_678",
  "customsFlag": "Import",
  "priceInformation": "Let's apply a discount for this order",
  "instructionsInformation": "This order has to be handled fast!",
  "contractTermsInformation": "International terms and conditions",
  "comment": "This is an urgent transport.",
  "voyage": {
    "meansName": "MSC GORILLA",
    "freightAgent": "CCGM",
    "shippingCompany": "ZIM",
    "eta": "2022-03-02T18:00:00+00:00",
    "etd": "2022-03-02T18:00:00+00:00",
    "closingCustoms": "2022-03-02T18:00:00+00:00",
    "closingDangerous": "2022-03-02T18:00:00+00:00",
    "closingDelivery": "2022-03-02T18:00:00+00:00"
  }
}
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!"
}
Response examples (412) 
{
  "timestamp": "2022-11-08T14:17:19Z",
  "code": "ACTOR_NOT_FOUND",
  "message": "Commande de transport est introuvable!"
}
Response examples (412) 
{
  "timestamp": "2022-11-08T14:17:19Z",
  "code": "ACTOR_NOT_FOUND",
  "message": "Commande de transport est introuvable!"
}