Create Order
All the ‘N/A’fields or optional fields can be sent as blank or can be removed as well from the payload.
URL
Staging https://api-staging.sepexconnect.com/
UAT https://api-uat.fareyeconnect.com/
Endpoint
POST connector/v1/sepex/create-order/speedx
Attributes
ship_from
Object - Required
ship_to
Object - Required
bill_to
Object
return_to
Object
shipper
Object
carrier
Object
shipment_details
Object
Ship From Definition
address
Object - Required
payment_details
Object
start_time
String
Ship from start time
end_time
String
Ship from end time
time_zone
String
Timezone of origin city
merchant_code
String
Unique merchant code
Ship To Definition
address
Object - Required
payment_details
Object
start_time
String
Ship from start time
end_time
String
Ship from end time
time_zone
String
Timezone of origin city
Bill To Definition
address
Object
Return To Definition
address
Object
start_time
String
Ship from start time
end_time
String
Ship from end time
time_zone
String
Timezone of origin city
Shipper Definition
shipper_code
String
Unique id/code of shipper
rate_card_code
String
Rate card code in Sepex
branded_exp
String
Branded exp
commission_code
String
Commission code
address
Object
Carrier Definition
carrier_code
String
Unique code of the carrier
carrier_service_type
String
Type of service offered by carrier
carrier_price
String
Carrier price
address
Object
Shipment Details Definition
key
String
Unique values
order_number
String - Required
Unique Order number used to identify an order
tracking_number
String
If tracking number is pre-generated by system
shipment_number
String
A user-provided key that should be unique to each order. If an shipment number is not provided, FarEye will create a new shipment and generate a unique shipment number
shipment_type
String
Type of order like Forward, Reverse,etc. Note: The origin and destination de tail will be filled basis on this type of order
service_type
String
Type of Services offered by the carrier
payment_mode
String
The method of payment will be used by the customer
package_details
List of Objects - Required
sku_details
List of Objects
The SKU (stock keeping unit) identifier for the product associated with this line item Sku Details Definition
quality_check_details
List of Objects
This is applicable if Shipment Type == Exchange. This will consist all the quality checklist questions and Answer to help in quality check by the driver Quality Check Details Definition
additional_free_json
Object
Send additional customs fields if needed Additional Free Json Definition
special_instructions
String
Any special instruction for shipment/product
order_date
String
The date the order was placed
ship_by_date
String
The date the order is to be shipped before or on. This field is a suggested value generated by the order source/platform/cart and passed to Sepex
incoterm
String
DAP, DDP, or EXW. For cross borders shipments the default value it's not specified in the request differently
order_invoice_number
String
Invoice Number if any
insurance_options
Object
The shipping insurance information associated with this order Insurance Options Definition
modality
String
"Parcel" "Air" "Ocean" "Other" "Road"
Address Definition
type
String
Type of operation B2B, B2C, Big Bulky
port
String - Required (ship_from)
Unique port name or code
code
String - Required (ship_from)
Unique code of location(fullfillment center code)
name
String - Required (ship_from, ship_to)
Name of person
address_line_1
String - Required (ship_from, ship_to)
Address line 1
address_line_2
String - Required (ship_from, ship_to)
Address line 2
address_line_3
String
Address line 3
landmark
String
Landmark
String
contact_number
String
Contact Number
city
String - Required (ship_from, ship_to)
City
state
String - Required (ship_from, ship_to)
State province code
pincode
String - Required (ship_from, ship_to)
pincode/postal code
county
String
A county is a geographic region of a country
country
String - Required
Country code. The two-letter ISO Origin. Country code is required
latitude
Decimal
Latitude
longitude
Decimal
Longitude
Payment Details Definition
payment_mode
String
Mode of payment at origin
amount_to_be_collected
Number
Amount to be collected at origin
Package Details Definition
length
Number - Required
Length of package
breadth
Number - Required
Breadth of package
height
Number
Height of package(Default will be set to 1)
weight
Number - Required
Weight of package
volume
Number
Volume of package
unit_of_measure
String
Dimensions unit of measure IN, CM (Default is Inches)
weight_unit_of_measure
String
Weight unit of measure OZ, LB, GM (Default is Pounds)
package_id
String
Unique package id
package_description
String
Package Description
package_code
String
Package code
package_value
Number
Value of the package
package_type
String
Type of parcel like BOX, BAG
Sku Details Definition
code
String
Unique code of SKU as per WMS
name
String
Name for SKU item
hsn_name
String
Special identification number that can be used to determine a variety of information about a product
quantity
String
The quantity of product ordered
unit_price
String
SKU unit price
image_url
String
Item image URL
package_id
String
Associated package id
Quality Check Details Definition
label
String
Add quality checklist question For Example: Model Number, IMEI number, Color of the Item etc, based on the type of shipment (item). json: qc_label: IMEI Number of the device
checkpoint
String
QC Check point details
image
String
The public URL to the product image
value
String
Add quality checklist Answers Example: answer to model number could be: "S1201" json: qc_value: "S1201" or answer to color could be "Red" json: qc_value: "Red"
Additional Free Json Definition
shipment_description
String
This provides the information about the parcel
label_format
String
It represents the format in which merchant need the label, default will be ZPL while the other 2 supported formats are PDF & PNG
sepex_country_code
String - Required
It signifies the country ISO code
parcel_shape
String
R - Rectangular NR - Non-Rectangular Default will be considered as Rectangular
Insurance Options Definition
provider
String
The "provider" option is used to indicate that a shipment was insured by a third party
insured_value
String
Value to insure
{
"ship_from": {
"address": {
"type": "",
"port": "MIAMI/SKYPOSTAL/WH01",
"code": "mia/skypostal",
"name": "TK Elevator Puerto Rico",
"address_line_1": "Calle 4",
"address_line_2": "Cataño, 00962, Puerto Rico",
"address_line_3": "",
"landmark": "",
"email": "",
"contact_number": "1234567890",
"city": "Cataño",
"state": "",
"pincode": "00962",
"county": "",
"country": "",
"latitude": "18.4629596",
"longitude": "-66.0868198"
},
"payment_details": {
"payment_mode": "",
"amount_to_be_collected": ""
},
"start_time": "",
"end_time": "",
"time_zone": "",
"merchant_code": ""
},
"ship_to": {
"address": {
"type": "",
"port": "",
"code": "",
"name": "SuperMax",
"address_line_1": "Centro Comercial, PR-693 Km. 8, Dorado Del Mar",
"address_line_2": "Dorado 00646, Puerto Rico",
"address_line_3": "",
"landmark": "FP7H+8R Dorado",
"email": "kshitiz.agarwal@fareye.com",
"contact_number": "8650826585",
"city": "Dorado",
"state": "",
"pincode": "00646",
"county": "",
"country": "",
"latitude": "",
"longitude": ""
},
"payment_details": {
"payment_mode": "",
"amount_to_be_collected": ""
},
"start_time": "",
"end_time": "",
"time_zone": ""
},
"bill_to": {
"address": {
"type": "",
"port": "",
"code": "",
"name": "",
"address_line_1": "",
"address_line_2": "",
"address_line_3": "",
"landmark": "",
"email": "",
"contact_number": "",
"city": "",
"state": "",
"pincode": "",
"county": "",
"country": "",
"latitude": "",
"longitude": ""
}
},
"return_to": {
"address": {
"type": "",
"port": "",
"code": "",
"name": "SEPEX PR LLC",
"address_line_1": "Caribe Office Building, 53 Palmeras Street, Suite 1601",
"address_line_2": "San Juan, PR 00901",
"address_line_3": "",
"landmark": "Offix",
"email": "",
"contact_number": "8650826585",
"city": "",
"state": "",
"pincode": "00901",
"county": "",
"country": "",
"latitude": "",
"longitude": ""
},
"start_time": "",
"end_time": "",
"time_zone": ""
},
"shipper": {
"shipper_code": "",
"rate_card_code": "",
"branded_exp": "",
"commission_code": "",
"address": {
"type": "",
"port": "",
"code": "",
"name": "",
"address_line_1": "",
"address_line_2": "",
"address_line_3": "",
"landmark": "",
"email": "",
"contact_number": "",
"city": "",
"state": "",
"pincode": "",
"county": "",
"country": "",
"latitude": "",
"longitude": ""
}
},
"carrier": {
"carrier_code": "",
"carrier_service_type": "",
"carrier_price": "",
"address": {
"name": "",
"address_line_1": "",
"address_line_2": "",
"address_line_3": "",
"landmark": "",
"email": "",
"contact_number": "",
"city": "",
"state": "",
"pincode": "",
"county": "",
"country": "",
"latitude": "",
"longitude": ""
}
},
"shipment_details": {
"key": "",
"order_number": "PUMA524ANG3607",
"tracking_number": "",
"shipment_number": "",
"shipment_type": "",
"service_type": "",
"payment_mode": "",
"package_details": [
{
"length": 16,
"breadth": 14.6,
"height": 6.1,
"weight": 3,
"volume": 400,
"unit_of_measure": "",
"weight_unit_of_measure": "",
"package_id": "",
"package_description": "",
"package_code": "",
"package_value": 90000,
"package_type": ""
}
],
"sku_details": [
{
"code": "",
"name": "",
"hsn_name": "",
"quantity": "",
"unit_price": "",
"image_url": "",
"package_id": ""
}
],
"quality_check_details": [
{
"label": "",
"checkpoint": "",
"image": "",
"value": ""
}
],
"additional_free_json": {
"shipment_description": "White Shoes",
"label_format": "PDF",
"sepex_country_code": "US",
"parcel_shape": "NR"
},
"special_instructions": "",
"order_date": "",
"ship_by_date": "",
"incoterm": "",
"order_invoice_number": "",
"insurance_options": {
"provider": "",
"insured_value": ""
},
"modality": ""
}
}{
"timestamp": 1690197300160,
"order_number": "PUMA524ANG3607",
"reference_number": "",
"errors": [],
"execution_time": 0,
"tracking_details": [
{
"package_id": "",
"tracking_number": "SXPR10000000000000829",
"label": "https://staging.fareye.co/img/pdf/download_label?query=0SS%2FL7dqPtRdpJAKw9KIaEnfdI6YJJn5tluQ66p4M2u0PUY95qLedpO66rR3tk4rvR8qAmghPgWg%2B1siJ6BhuXM%3D"
}
],
"carrier_details": {
"carrier_code": "puma_ownfleet",
"carrier_name": "PUMA/OWNFLEET",
"carrier_type": null,
"carrier_service_type": null,
"carrier_address_line1": null,
"carrier_address_line2": null,
"carrier_landmark": null,
"carrier_city": null,
"carrier_hub": null,
"carrier_email": null,
"carrier_service_area_pincode": null,
"carrier_price": null,
"carrier_contact_number": null,
"rank": 1,
"rate": null,
"score": 0,
"output_tags": {
"label_identifier": "PRI "
}
}
}