OmniReturns Label Creation API

Destination

Y

Refer to Receiver Information
Refer to Address Information

This is the first mile destination of the return. If returns are being processed by Seko, this will be our hub address which needs to be requested from your account manager

SendTrackingEmail

Optional

Boolean

Should a track and trace email be sent on pickup. Use “false” if you send your own email to the customer with the label

Origin

Y

Same attributes as Destination.

Packages

Y

Refer to Package Information

Commodities

Y

Refer to Commodity Information

DeliveryReference

Y

String (1000 characters)

Shipment reference number / Order Number / RT Number

Reference2

Optional

String (500 characters)

Additional Shipment Reference / OrderNo field.

Reference3

Optional

String (500 characters)

Additional Shipment Reference

RPSProcessing

Mandatory if returns are processed at a Seko Hub

Boolean

If this return will be processed at a Seko hub, use “true”
If this return will going direct to the retailers or a 3rd party facility, use “False” or omit

Outputs

Optional

JSON string array. Refer to Output Information

Carrier

Optional

String(50 Characters)

Where multiple carrier options are available, a carrier can be pre-nominated. E.g “Omni Parcel”

Service

Optional

String

Where multiple service options are available, a service can be pre- nominated. Eg. “Air Tracked” or “Air Untracked”

Postcodevalidate

Optional

Boolean

If “true” OmniParcel will check postcode and overwrite destination suburb and city provided in API request. Available for New Zealand only.

ShipType

Y

String

MUST be“INBOUND” for returns

ProductCategory

Optional

String (50 characters)

Product category used to group products

SendLabel

Optional

String (1 Character)

“Y” Or “N” – if “Y” then email from OmniParcel will be sent to the customer containing the return label

IncludeLineDetails

Optional

Boolean

If ``True`` then in Response Item details will be provided with TrackingBarcode details.

Name

Y

String (50 characters)

Consignee name/Business name

Email

Y

String(200 characters)

Email address

ContactPerson

Y

String(50 characters)

Contact person for delivery

PhoneNumber

Y

String(50 characters)

Phone contact number for delivery

BuildingName

Y

String (50 characters)

Address identifier, e.g. Unit 1, Level 2

StreetAddress

Y

String (50 characters)

Street address e.g. 32 Sommer Place

Suburb

Y

String (50 characters)

Suburb Name

City

Y

String (50 characters)

City/State Name. AU/US – States to be provided as abbreviations, eg. VIC – Victoria CA – California

PostCode

Y

String (20 characters)

Postal code or Zip code

CountryCode

Y

String (2 characters)

2 letter Country code, e.g. US, NZ, AU, CN, CA, etc (Please use GB instead of UK)

Name

Y

String (50 characters)

Consignee name/Business name

ID

N

String

Number to identify package

Length

Y

Decimal (4dp)

Length of package in centimeters. Use 1 if not available

Width

Y

Decimal (4dp)

Width of package in centimeters. Use 1 if not available

Height

Y

Decimal (4dp)

Height of package in centimeters. Use 1 if not available

Kg

Y

Decimal (4dp)

Weight of package in Kilos

Type

Y

String (30 characters)

Package type, Valid values are: Bag, Box, Carton, Satchel

Use Box if unsure

Description

Y

String

Product name or description of the item

Leave With Me Dress In Navy Fl

Units

N

Numerical

Count of specific item

1

UnitValue

Y

Decimal

Value of the item per unit

25

UnitKg

Y

Decimal

Weight of the item per unit

0.25

Country

N

String

Country of items origin

New Zealand

Currency

Y

String

Currency of UnitValue

NZD

ItemNo

N

String

Item Number

12312

SKU

Y

String

SKU Number

ST1306B-white

Reason

Y - if Seko is processing

String

Reason this item is being returned

Too Big

ReturnAction

Y - if Seko is processing

String

Reconciliation method supplied to the customer for the return

REFUND

CommodityCode

Y - if return will go internationally

HS Code used by customs to classify the product

430310

LABEL_PDF

Optional

String(200)

Label is presented on an A4 page

LABEL_PNG_100X175

Optional

String(200)

Label is presented as a PNG image with dimension 100mm x 175mm

LABEL_PNG_100X150

Optional

String(200)

Label is presented as a PNG image with dimension 100mm x 150mm

LABEL_PDF_100X175

Optional

String(200)

Label is presented as a PDF with dimension 100mm x 175mm

LABEL_PDF_100X150

Optional

String(200)

Label is presented as a PDF with dimension 100mm x 150mm

CarrierId

Decimal

Internal OmniParcel identification number for the carrier

CarrierName

String

Courier Name

Message

String

Notification message for shipment create request

Errors

String

Validation errors if fields are incomplete or incorrect.

SiteId

Decimal

Your account site Id

Consignments

String

Consignment and tracking numbers

IsFreightForward

Boolean

Not relevant for returns

TrackingUrl

String

OmniParcel tracking URL, this will only show first mile tracking events. Not the end to end tracking for a return (processing, consolidation)

Cost

Decimal ( 2dp)

Cost of label

CarrierType

Integer

Internal Carrier Type

IsSaturdayDelivery

Boolean

Not relevant for returns

IsRural

Boolean

Not relevant for returns

IsOvernight

Boolean

Not relevant for returns

HasTrackPaks

Boolean

Not relevant for returns

Property

String

Message

String

No applicable rate resolved.

Rates must be explicitly configured for each account, for both origin and destination. This error means the country you have requested a label for has not been configured. You will need to check with your Account Manager.

Request Timeout

The request took longer than 60 seconds to complete so was ended. This could be due to the carrier taking too long to respond. Please try again.

. . . Your combination of suburb, state & postcode doesn't match. . . .

These address fields are validated by the Omni systems and the carrier. If validation failed in either system, you will get a similar error message.

You will need to check these details and resend the request with the correct data. You can use the local carriers website to find the correct details.

. . . The attempted Suburb\/City\/Postcode combination does not exist in the database . . .

per above

. . . OmniParcel character limit for field [fieldname] is 1 to 50 characters but carrier limit for this field is 35 characters . . .

You have sent a field which exceeds the character limit. You will need to edit this field and resend.