Add a new Package

post

https://api-sandbox-revel.revelup.com/resources/Package/

Add a new Package

Body Params

Package object that needs to be added

active

boolean

Defaults to true

Flag. If set to True, the Package is visible and can be used.

actual_ship_date

date-time

Actual shipping date of the package.

address

object

required

Address object in the form of JSON, primary_billing and primary_shipping fields are required. All other fields are not required, and as this is JSON object it can have additional fields that are provided in the request.

created_by

uri

required

URI of the user that created Package resource.

created_date

date-time

Date and time when Package resource was created.

external_shipping_address

object

items

array

required

items*

notes

string

Notes about this Package resource.

order

string

required

Order that this Package resource is attached to.

packaging

string

length ≤ 100

Type of packing , free field. Example: Envelope box.

rate

number

> 0

Decimal number with two decimal places, that is the rate of Package resource.

service_code

string

length ≤ 100

Specific code that would link to shipping method integration, customer facing.

service_name

string

length ≤ 50

Name of the service for this Package resource.

shipping_charge

float

required

Price of shipping for this Package resource.

shipping_company

integer

enum

required

Shiping companies. 0 - Unknown, 1 - UPS, 2 - FedEx, 3 - '', 4 - Revel Shipping.

Shipment Companies:

0 - SHIPMENT_COMPANY_UNKNOWN
1 - SHIPMENT_COMPANY_UPS
2 - SHIPMENT_COMPANY_FEDEX
3 - SHIPMENT_COMPANY_WITH_COMPLIANCE
4 - SHIPMENT_COMPANY_REVEL_SHIPPING

Allowed:

shipping_label

string

Label of the shipping

signature_required

boolean

Defaults to false

True if package need to be signed for.

state

integer

enum

State in which is the Package. 0 - Incomplete, 1 - Shipping, 2 - Shipped.

Package States:

0 - PACKAGE_STATE_INCOMPLETE
1 - PACKAGE_STATE_SHIPPING
2 - PACKAGE_STATE_SHIPPED

Allowed:

target_ship_date

date

required

Date when package is going to be shipped.

tax_option

integer

enum

Tax options for packages. 0 - None, 1 - Local, 2 - Destination-based

Package Tax Options:

0 - PACKAGE_TAX_OPTION_NONE
1 - PACKAGE_TAX_OPTION_LOCAL
2 - PACKAGE_TAX_OPTION_DESTINATION_BASED

Allowed:

tracking_number

string

length ≤ 100

Number attached to package. Package can be then tracked by this number, also Packages can then be filtered by this number.

updated_by

uri

required

URI of the user that updated Package resource.

updated_date

date-time

Date and time when Package resource was updated.

uuid

UUID of this Package resource.

weight

float

required

Weight of the package.

Responses

201

Resource successfully created.

400

Invalid input - please run the request body through a JSON validator.