Overslaan en naar hoofdcontent gaan

Sales Order Import API Specification

  • Bijgewerkt

Type: object

path: #

$schema: http://json-schema.org/draft-07/schema#

 

This schema does not accept additional properties.

Properties

  • in
    • Type: object
    • path: #/properties/in
    • This schema does not accept additional properties.
    • Properties
      • update_code required
        • Only INSERT_AND_UPDATE and CANCELLED are currently supported.
        • Type: string
        • path: #/properties/in/properties/update_code
        • The value is restricted to the following:
          • "INSERT"
          • "INSERT_AND_UPDATE"
          • "UPDATE"
          • "CANCELLED"
        • Length:  ≤ 17
      • sales_channel_reference required
        • Type: string
        • path: #/properties/in/properties/sales_channel_reference
      • status
        • The default status is "C" (closed), unless the value is set to "O" (open).
        • Type: string
        • path: #/properties/in/properties/status
      • run_number
        • Type: string
        • path: #/properties/in/properties/run_number
        • Length:  ≤ 15
      • order_reference required
        • Identifier of the order in the external system.
        • Type: string
        • path: #/properties/in/properties/order_reference
        • Length:  ≤ 50
      • order_description
        • It will be saved in the field orderref_description in the order_header table.
        • Type: string
        • path: #/properties/in/properties/order_description
        • Length:  ≤ 50
      • partial_delivery_allowed
        • The default value for partial_delivery_allowed depends on a setting: /wms/Default Settings/Orderpicking/partial_delivery_allowed
        • Type: boolean
        • path: #/properties/in/properties/partial_delivery_allowed
      • warehouse_reference
        • Type: string
        • path: #/properties/in/properties/warehouse_reference
        • Length:  ≥ 1
      • on_hold
        • Type: boolean
        • path: #/properties/in/properties/on_hold
      • properties
        • Type: array
        • path: #/properties/in/properties/properties
          • Items
-        Property value that provides custom business logic.
  • Type: object
  • path: #/properties/in/properties/properties/items
  • This schema does not accept additional properties.
  • Properties
    • name required
      • Name of the property type.
      • Type: string
      • path: #/properties/in/properties/properties/items/properties/name
      • Length:  ≤ 30
    • value required
      • Value of the property.
      • Type: string
      • path: #/properties/in/properties/properties/items/properties/value
      • Length:  ≤ 250
  • send_type_classification
  • If the agent codes are used, then a send type classification reference is build with those codes and used as if st_class_reference was given. Thus, to use it properly, use either the agent codes or the classification reference
  • Type: object
  • path: #/properties/in/properties/send_type_classification
  • This schema does not accept additional properties.
  • Properties
  • st_agent_shipping_code
    • Type: string
    • path: #/properties/in/properties/send_type_classification/properties/st_agent_shipping_code
  • st_agent_shipping_service_code
    • Type: string
    • path: #/properties/in/properties/send_type_classification/properties/st_agent_shipping_service_code
  • st_class_reference
    • When given, that classification is looked up. If it is not found, then an error is produced
    • Type: string
    • path: #/properties/in/properties/send_type_classification/properties/st_class_reference
  • pod
  • Type: object
  • path: #/properties/in/properties/pod
  • This schema does not accept additional properties.
  • Properties
  • reference required
    • Type: string
    • path: #/properties/in/properties/pod/properties/reference
    • Length:  ≥ 1
  • name required
    • Company name that will be stored in address.address_name.
    • Type: string
    • path: #/properties/in/properties/pod/properties/name
    • Length:  ≥ 1
  • contact_name required
    • Person name that will be stored in place_of_delivery.pod_name.
    • Type: string
    • path: #/properties/in/properties/pod/properties/contact_name
    • Length:  ≥ 1
  • street_name required
    • Type: string
    • path: #/properties/in/properties/pod/properties/street_name
    • Length:  ≥ 1
  • house_number
    • Type: integer
    • path: #/properties/in/properties/pod/properties/house_number
  • house_number_extension
    • Type: string
    • path: #/properties/in/properties/pod/properties/house_number_extension
  • zip_code
    • Type: string
    • path: #/properties/in/properties/pod/properties/zip_code
  • city
    • Type: string
    • path: #/properties/in/properties/pod/properties/city
  • country_reference required
    • Type: string
    • path: #/properties/in/properties/pod/properties/country_reference
    • Length:  ≥ 1
  • email_address
    • Type: string
    • path: #/properties/in/properties/pod/properties/email_address
  • mobile_number
    • Type: string
    • path: #/properties/in/properties/pod/properties/mobile_number
  • address_line_2
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_line_2
  • address_line_3
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_line_3
  • address_state
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_state
  • address_type
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_type
    • Length:  ≤ 1
  • order_lines
  • Type: array
  • path: #/properties/in/properties/order_lines
  • Items
  • Type: object
  • path: #/properties/in/properties/order_lines/items
  • This schema does not accept additional properties.
  • Properties
    • update_code required
      • Determines whether the outbound order line should be inserted and/or updated, or removed.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/update_code
      • The value is restricted to the following:
        1. "INSERT"
        2. "INSERT_AND_UPDATE"
        3. "UPDATE"
        4. "CANCELLED"
    • order_line_reference required
      • Identifier of the outbound order line in the external system.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/order_line_reference
      • Length: between 1 and 50
    • product_reference
      • Identifier of the product in the external system.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/product_reference
      • Length:  ≤ 50
    • order_line_quantity
      • Amount of stock that will be delivered.
      • Type: number
      • path: #/properties/in/properties/order_lines/items/properties/order_line_quantity
      • Exclusive Range:  > 0
    • picking_task_reference
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/picking_task_reference
      • Length:  ≤ 50
    • ool_picking_task_name
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/ool_picking_task_name
      • Length:  ≤ 30
    • process_type_code
      • Code of the process type that will be used to pick the stock.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/process_type_code
      • Length:  ≤ 6
    • ool_delivery_date
      • Expected delivery date, date format: YYYY-MM-DD
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/ool_delivery_date
    • ool_sorting_code
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/ool_sorting_code
      • Length:  ≤ 60
    • customer_order_reference
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/customer_order_reference
      • Length:  ≤ 50
    • properties
      • Type: array
      • path: #/properties/in/properties/order_lines/items/properties/properties
        • Items
        • Property value that provides custom business logic.
        • Type: object
        • path: #/properties/in/properties/order_lines/items/properties/properties/items
        • This schema does not accept additional properties.
  • Properties
    • name required
    • Name of the property type.
    • Type: string
    • path: #/properties/in/properties/order_lines/items/properties/properties/items/properties/name
    • Length:  ≤ 30
  • value required
    • Value of the property.
    • Type: string
    • path: #/properties/in/properties/order_lines/items/properties/properties/items/properties/value
    • Length:  ≤ 250

Properties

  • in
    • Type: object
    • path: #/properties/in
    • This schema does not accept additional properties.
    • Properties
      • update_code required
        • Only INSERT_AND_UPDATE and CANCELLED are currently supported.
        • Type: string
        • path: #/properties/in/properties/update_code
        • The value is restricted to the following:
          • "INSERT"
          • "INSERT_AND_UPDATE"
          • "UPDATE"
          • "CANCELLED"
        • Length:  ≤ 17
      • sales_channel_reference required
        • Type: string
        • path: #/properties/in/properties/sales_channel_reference
      • status
        • The default status is "C" (closed), unless the value is set to "O" (open).
        • Type: string
        • path: #/properties/in/properties/status
      • run_number
        • Type: string
        • path: #/properties/in/properties/run_number
        • Length:  ≤ 15
      • order_reference required
        • Identifier of the order in the external system.
        • Type: string
        • path: #/properties/in/properties/order_reference
        • Length:  ≤ 50
      • order_description
        • It will be saved in the field orderref_description in the order_header table.
        • Type: string
        • path: #/properties/in/properties/order_description
        • Length:  ≤ 50
      • partial_delivery_allowed
        • The default value for partial_delivery_allowed depends on a setting: /wms/Default Settings/Orderpicking/partial_delivery_allowed
        • Type: boolean
        • path: #/properties/in/properties/partial_delivery_allowed
      • warehouse_reference
        • Type: string
        • path: #/properties/in/properties/warehouse_reference
        • Length:  ≥ 1
      • on_hold
        • Type: boolean
        • path: #/properties/in/properties/on_hold
      • properties
        • Type: array
        • path: #/properties/in/properties/properties
          • Items
-        Property value that provides custom business logic.
  • Type: object
  • path: #/properties/in/properties/properties/items
  • This schema does not accept additional properties.
  • Properties
    • name required
      • Name of the property type.
      • Type: string
      • path: #/properties/in/properties/properties/items/properties/name
      • Length:  ≤ 30
    • value required
      • Value of the property.
      • Type: string
      • path: #/properties/in/properties/properties/items/properties/value
      • Length:  ≤ 250
  • send_type_classification
  • If the agent codes are used, then a send type classification reference is build with those codes and used as if st_class_reference was given. Thus, to use it properly, use either the agent codes or the classification reference
  • Type: object
  • path: #/properties/in/properties/send_type_classification
  • This schema does not accept additional properties.
  • Properties
  • st_agent_shipping_code
    • Type: string
    • path: #/properties/in/properties/send_type_classification/properties/st_agent_shipping_code
  • st_agent_shipping_service_code
    • Type: string
    • path: #/properties/in/properties/send_type_classification/properties/st_agent_shipping_service_code
  • st_class_reference
    • When given, that classification is looked up. If it is not found, then an error is produced
    • Type: string
    • path: #/properties/in/properties/send_type_classification/properties/st_class_reference
  • pod
  • Type: object
  • path: #/properties/in/properties/pod
  • This schema does not accept additional properties.
  • Properties
  • reference required
    • Type: string
    • path: #/properties/in/properties/pod/properties/reference
    • Length:  ≥ 1
  • name required
    • Company name that will be stored in address.address_name.
    • Type: string
    • path: #/properties/in/properties/pod/properties/name
    • Length:  ≥ 1
  • contact_name required
    • Person name that will be stored in place_of_delivery.pod_name.
    • Type: string
    • path: #/properties/in/properties/pod/properties/contact_name
    • Length:  ≥ 1
  • street_name required
    • Type: string
    • path: #/properties/in/properties/pod/properties/street_name
    • Length:  ≥ 1
  • house_number
    • Type: integer
    • path: #/properties/in/properties/pod/properties/house_number
  • house_number_extension
    • Type: string
    • path: #/properties/in/properties/pod/properties/house_number_extension
  • zip_code
    • Type: string
    • path: #/properties/in/properties/pod/properties/zip_code
  • city
    • Type: string
    • path: #/properties/in/properties/pod/properties/city
  • country_reference required
    • Type: string
    • path: #/properties/in/properties/pod/properties/country_reference
    • Length:  ≥ 1
  • email_address
    • Type: string
    • path: #/properties/in/properties/pod/properties/email_address
  • mobile_number
    • Type: string
    • path: #/properties/in/properties/pod/properties/mobile_number
  • address_line_2
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_line_2
  • address_line_3
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_line_3
  • address_state
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_state
  • address_type
    • Type: string
    • path: #/properties/in/properties/pod/properties/address_type
    • Length:  ≤ 1
  • order_lines
  • Type: array
  • path: #/properties/in/properties/order_lines
  • Items
  • Type: object
  • path: #/properties/in/properties/order_lines/items
  • This schema does not accept additional properties.
  • Properties
    • update_code required
      • Determines whether the outbound order line should be inserted and/or updated, or removed.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/update_code
      • The value is restricted to the following:
        1. "INSERT"
        2. "INSERT_AND_UPDATE"
        3. "UPDATE"
        4. "CANCELLED"
    • order_line_reference required
      • Identifier of the outbound order line in the external system.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/order_line_reference
      • Length: between 1 and 50
    • product_reference
      • Identifier of the product in the external system.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/product_reference
      • Length:  ≤ 50
    • order_line_quantity
      • Amount of stock that will be delivered.
      • Type: number
      • path: #/properties/in/properties/order_lines/items/properties/order_line_quantity
      • Exclusive Range:  > 0
    • picking_task_reference
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/picking_task_reference
      • Length:  ≤ 50
    • ool_picking_task_name
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/ool_picking_task_name
      • Length:  ≤ 30
    • process_type_code
      • Code of the process type that will be used to pick the stock.
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/process_type_code
      • Length:  ≤ 6
    • ool_delivery_date
      • Expected delivery date, date format: YYYY-MM-DD
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/ool_delivery_date
    • ool_sorting_code
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/ool_sorting_code
      • Length:  ≤ 60
    • customer_order_reference
      • Type: string
      • path: #/properties/in/properties/order_lines/items/properties/customer_order_reference
      • Length:  ≤ 50
    • properties
      • Type: array
      • path: #/properties/in/properties/order_lines/items/properties/properties
        • Items
        • Property value that provides custom business logic.
        • Type: object
        • path: #/properties/in/properties/order_lines/items/properties/properties/items
        • This schema does not accept additional properties.
  • Properties
    • name required
    • Name of the property type.
    • Type: string
    • path: #/properties/in/properties/order_lines/items/properties/properties/items/properties/name
    • Length:  ≤ 30
  • value required
    • Value of the property.
    • Type: string
    • path: #/properties/in/properties/order_lines/items/properties/properties/items/properties/value
    • Length:  ≤ 250

Gerelateerd aan

Verwante artikelen