Omnyfy
Powered by Redocly

Shipment

Estimate shipping methods

Estimate shipping by address and return list of available shipping methods

Request
path Parameters
cartId
required
string
Request Body schema:
optional
required
object (quote-data-address-interface)

Interface AddressInterface

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/carts/{cartId}/estimate-shipping-methods
Request samples
{
  • "address": {
    }
}
Response samples
[
  • {
    }
]

Get Shipment

Loads a specified shipment.

Request
path Parameters
id
required
integer

The shipment ID.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/shipment/{id}
Response samples
{
  • "billing_address_id": 0,
  • "created_at": "string",
  • "customer_id": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "increment_id": "string",
  • "order_id": 0,
  • "packages": [
    ],
  • "shipment_status": 0,
  • "shipping_address_id": 0,
  • "shipping_label": "string",
  • "store_id": 0,
  • "total_qty": 0,
  • "total_weight": 0,
  • "updated_at": "string",
  • "items": [
    ],
  • "tracks": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}

Get Shipments

Lists shipments that match specified search criteria. This call returns an array of objects

Request
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/rest/V1/shipments
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

Create Shipment

Native API call to create an shipment.

Request
Request Body schema:
required
required
object (sales-data-shipment-interface)

Shipment interface. A shipment is a delivery package that contains products. A shipment document accompanies the shipment. This document lists the products and their quantities in the delivery package.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

post/rest/V1/shipment
Request samples
{
  • "entity": {
    }
}
Response samples
{
  • "billing_address_id": 0,
  • "created_at": "string",
  • "customer_id": 0,
  • "email_sent": 0,
  • "entity_id": 0,
  • "increment_id": "string",
  • "order_id": 0,
  • "packages": [
    ],
  • "shipment_status": 0,
  • "shipping_address_id": 0,
  • "shipping_label": "string",
  • "store_id": 0,
  • "total_qty": 0,
  • "total_weight": 0,
  • "updated_at": "string",
  • "items": [
    ],
  • "tracks": [
    ],
  • "comments": [
    ],
  • "extension_attributes": {
    }
}
➔ Next to Webhooks