GuidesAPI ReferenceChangelog
HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
API Reference
Start typing to search…

Update Package by ID

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

Updates a single Package object

Log in to see full request history
Path Params
int64
required

ID of the Package API object

Body Params

Package data that needs to be changed

boolean
Defaults to true

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

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.

uri
required

URI of the user that created Package resource.

date-time

Date and time when Package resource was created.

external_shipping_address
object

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.

items
array
required
items*
string

Notes about this Package resource.

string
required

Order that this Package resource is attached to.

string
length ≤ 100

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

number
> 0

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

string
length ≤ 100

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

string
length ≤ 50

Name of the service for this Package resource.

float
required

Price of shipping for this Package resource.

integer
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
string

Label of the shipping

boolean
Defaults to false

True if package need to be signed for.

integer

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
date
required

Date when package is going to be shipped.

integer

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
string
length ≤ 100

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

uri
required

URI of the user that updated Package resource.

date-time

Date and time when Package resource was updated.

uuid

UUID of this Package resource.

float
required

Weight of the package.

Responses

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

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

404

Package with the provided ID not found.

Updated over 1 year ago

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago