Fulfillment Order
An order can now have multiple shipments. Each shipment is described in a new entity called Fulfillment Order.
Backward compatibility
Fulfillment Order keeps a backward compatibility with Order Shipping Information. Compare the atributes from orders shipping to fulfillment orders.
Orders V1 to Fulfillment Orders
Order V1 | Fulfillment Orders |
---|---|
order.shipping_name | fulfillment_order.recipient.name |
order.shipping_phone | fulfillment_order.recipient.phone |
order.shipping_address | fulfillment_order.destination.street |
order.shipping_number | fulfillment_order.destination.number |
order.shipping_floor | fulfillment_order.destination.floor |
order.shipping_locality | fulfillment_order.destination.locality |
order.shipping_zipcode | fulfillment_order.destination.zipcode |
order.shipping_city | fulfillment_order.destination.city |
order.shipping_province | fulfillment_order.destination.province.name |
order.shipping_country | fulfillment_order.destination.country.name |
order.shipping_min_days | fulfillment_order.shipping.min_delivery_date (non compatible type) |
order.shipping_max_days | fulfillment_order.shipping.max_delivery_date (non compatible type) |
order.shipping_cost_owner | fulfillment_order.shipping.owner_cost.value |
order.shipping_cost_customer | fulfillment_order.shipping.owner_customer.value |
order.shipping | fulfillment_order.shipping.carrier.carrier_id |
order.shipping_option | fulfillment_order.shipping.option_name |
order.shipping_option_code | fulfillment_order.shipping.option_code |
order.shipping_option_reference | fulfillment_order.shipping.option_reference |
order.shipping_pickup_details.* | fulfillment_order.shipping.pickup_details |
order.shipping_pickup_details.name | fulfillment_order.shipping.pickup_details.name |
order.shipping_pickup_details.address | fulfillment_order.shipping.pickup_details.address |
order.shipping_pickup_details.city | fulfillment_order.shipping.pickup_details.city |
order.shipping_pickup_details.province | fulfillment_order.shipping.pickup_details.province.name |
order.shipping_pickup_details.pickup_hours | fulfillment_order.shipping.pickup_details.pickup_hours |
order.shipping_tracking_number | fulfillment_order.tracking_info.number |
order.shipping_tracking_url | fulfillment_order.tracking_info.url |
order.shipping_store_branch_name | fulfillment_order.shipping.pickup_details.name |
order.shipping_pickup_type | fulfillment_order.shipping.type |
order.shipping_suboption | fulfillment_order.shipping.pickup_details |
order.shipping_suboption.id | fulfillment_order.shipping.pickup_details.location_id |
order.shipping_carrier_name | fulfillment_order.shipping.carrier_name |
order.shipping_address.name | fulfillment_order.recipient.name |
order.shipping_address.phone | fulfillment_order.recipient.phone |
order.shipping_address.address | fulfillment_order.destination.street |
order.shipping_address.number | fulfillment_order.destination.number |
order.shipping_address.floor | fulfillment_order.destination.floor |
order.shipping_address.locality | fulfillment_order.destination.locality |
order.shipping_address.zipcode | fulfillment_order.destination.zipcode |
order.shipping_address.city | fulfillment_order.destination.city |
order.shipping_address.province | fulfillment_order.destination.province.name |
order.shipping_address.country | fulfillment_order.destination.country.name |
order.shipping_address.customers.reference | fulfillment_order.destination.reference |
order.shipping_address.customers.between_streets | fulfillment_order.destination.between_streets |
order.shipping_tracking_number | fulfillment_order.tracking_info.number |
order.shipping_tracking_url | fulfillment_order.tracking_info.url |
Orders Fulfillment Events V1 to Fulfillment Orders Tracking Events
Order Fulfillment Events V1 | Fulfillment Order Tracking Events |
---|---|
fulfillment_events.id | fulfillment_order.tracking_events.id |
fulfillment_events.status | fulfillment_order.tracking_events.status |
fulfillment_events.descritpion | fulfillment_order.tracking_events.description |
fulfillment_events.city | fulfillment_order.tracking_events.address (non compatible type) * |
fulfillment_events.province | fulfillment_order.tracking_events.address (non compatible type) * |
fulfillment_events.country | fulfillment_order.tracking_events.address (non compatible type) * |
created_at | fulfillment_order.tracking_events.created_at |
updated_at | fulfillment_order.tracking_events.updated_at |
happened_at | fulfillment_order.tracking_events.happened_at |
estimated_delivery_at | fulfillment_order.tracking_events.estimated_delivery_at |
non exists | fulfillment_order.tracking_events.geolocation |
*It's up to each application to define how the tracking address is represented as a string. The fulfillment event's city, province and country could be informed in fulfilment_order.tracking_events.address by concatenating all the information. Eg.: "Some street 31, Some City, Some State, Some Country".```
Scopes
Property | Explanation |
---|---|
read_fulfillment_orders | Allows you to read actions of one or more fulfillment orders for a merchant. |
write_fulfillment_orders | Allows you to write actions of one or more fulfillment orders for a merchant. |
Properties
FulfillmentOrder
Field Name | Field Type | Description |
---|---|---|
id | ID | The unique fulfillment order. (ULID) identification |
number | String | The unique fulfillment order nice number by store |
total_quantity | UnsignedInt | The Fulfillment order total line items quantity |
total_weight | Decimal | The fulfillment order total line items weight |
total_price | Money | The fulfillment order total line items price |
assigned_location | FulfillmentOrderAssignedLocation | The fulfillment order assigned location |
line_items | FulfillmentOrderLineItem[] | The fulfillment order line items |
recipient | FulfillmentOrderRecipient | The fulfillment order recipient |
shipping | FulfillmentOrderShipping | The fulfillment order shipping |
destination | FulfillmentOrderDestination | The fulfillment order destination |
discounts | FulfillmentOrderDiscount[] | The fulfillment order discounts |
status | FulfillmentOrderStatus | The fulfillment order status |
status_history | FulfillmentOrderStatusHistory[] | The fulfillment order status history. Default: []. |
tracking_info | FulfillmentOrderTrackingInfo | The fulfillment order tracking info |
tracking_info_history | FulfillmentOrderTrackingInfoHistory[] | The fulfillment order tracking info history. Default: [] |
tracking_events | FulfillmentOrderTrackingEvent[] | The fulfillment order tracking events. Default: []. |
fulfilled_at | DateTime | Date when the fulfillment order was sent in ISO 8601 format. Nullable. |
created_at | DateTime | Date when the fulfillment order was last created in ISO 8601 format. |
updated_at | DateTime | Date when the fulfillment order was last updated in ISO 8601 format. |
FulfillmentOrderAssignedLocation
Field Name | Field Type | Description |
---|---|---|
location_id | ID | The fulfillment order assigned location identification |
name | String | The fulfillment order assigned location name |
address | Address | The fulfillment order assigned location address |
FulfillmentOrderLineItem
Field Name | Field Type | Description |
---|---|---|
id | ID | The fulfillment order line item id |
external_id | ID | The order external id |
quantity | UnsignedInt | The fulfillment order line item quantity |
variant | FulfillmentOrderLineItemVariant | The fulfillment order line item variant |
product | FulfillmentOrderLineItemProduct | The fulfillment order line item product |
unit_price | Money | The fulfillment order line item order line line unit price |
unit_dimension | FulfillmentOrderLineItemDimension | The fulfillment order line item order line line unit dimension. |
created_at | DateTime | Date when the fulfillment order line item was last created in ISO 8601 format. |
updated_at | DateTime | Date when the fulfillment order line item was last updated in ISO 8601 format. |
FulfillmentOrderLineItemVariant
Field Name | Field Type | Description |
---|---|---|
variant_id | ID | The fulfillment order line item variant identification. |
FulfillmentOrderLineItemProduct
Field Name | Field Type | Description |
---|---|---|
product_id | ID | The fulfillment order line item product identification. |
FulfillmentOrderLineItemDimension
Field Name | Field Type | Description |
---|---|---|
weight | Decimal | The fulfillment order line item dimension weight. |
width | Decimal | The fulfillment order line item dimension width. |
height | Decimal | The fulfillment order line item dimension height. |
depth | Decimal | The fulfillment order line item dimension depth. |
FulfillmentOrderRecipient
Field Name | Field Type | Description |
---|---|---|
name | String | The fulfillment order recipient name. |
phone | String | The fulfillment order recipient phone. Optional |
identifier | String | The fulfillment order recipient identifier. Optional. |
FulfillmentOrderShipping
Field Name | Field Type | Description |
---|---|---|
type | FulfillmentOrderShippingType | The fulfillment order shipping type. |
carrier | Carrier | The fulfillment order shipping carrier. |
option | Option | The fulfillment order shipping option. |
merchant_cost | Money | The fulfillment merchant shipping option cost. |
consumer_cost | Money | The fulfillment consumer shipping option cost. |
min_delivery_date | DateTime | The fulfillment minimum estimated delivery date. Nullable. |
max_delivery_date | DateTime | The fulfillment maximum estimated delivery date. Nullable. |
pickup_details | FulfillmentOrderShippingPickupDetails | The fulfillment order shipping pickup details. Nullable. |
extras | FulfillmentOrderShippingExtraProperty | The fulfillment order shipping extra properties. Eg. {"free_shipping_id": "123456"}. Nullable. |
FulfillmentOrderShippingType
Type | Description |
---|---|
pickup | The fulfillment order shipping type for pickup point shipping options |
ship | The fulfillment order shipping type for ship shipping options |
non-shippable | The fulfillment order shipping type for non shippable |
FulfillmentOrderShippingPickupDetails
Field Name | Field Type | Description |
---|---|---|
location_id | String | The fulfillment order shipping pickup detail identification. Ex.: Location ID, IdCentroImposicion (OCA). |
store_branch_id | String | The fulfillment order shipping pickup detail identification for store_branch_id. This field will be deprecated with store branch features in the future. |
name | String | The fulfillment order shipping pickup details name |
address | Address | The fulfillment order shipping pickup details pickup point address |
pickup_hours | FulfillmentOrderPickupHour[] | The fulfillment order shipping pickup details pickup hours. Default: [] |
FulfillmentOrderPickupHour
Field Name | Field Type | Description |
---|---|---|
day | FulfillmentOrderPickupHourWeekday | The fulfillment order shipping pickup detail pickup the weekday. Eg.: MONDAY. |
start | String | The fulfillment order shipping pickup detail pickup hour the start hour. Eg.: 0800 |
end | String | The fulfillment order shipping pickup detail pickup hour the end hour. Eg.: 1800 |
FulfillmentOrderShippingExtraProperty
Field Name | Field Type | Description |
---|---|---|
free_shipping_info | FreeShippingInfo | The shipping extra property for free shipping information. |
phone_required | Boolean | The shipping option requires a consumer phone number flag indicator. |
id_required | Boolean | The shipping option requires a consumer document number flag indicator. |
accepts_cod | Boolean | The shipping option accepts cash on delivery flag indicator. |
show_time | Boolean | The shipping option must show the estimated delivery time flag indicator. |
shippable | Boolean | The shipping option is shippable, meaning the package will be sent to the consumer or to the pickup point. |
FreeShippingInfo
Field Name | Field Type | Description |
---|---|---|
free_shipping_id | ID | The fulfillment order shipping free shipping info free shipping identification. |
consumer_original_cost | Money | The fulfillment order shipping the consumer original cost, without applying the free shipping rules. |
FulfillmentOrderPickupHourWeekday
Type | Description |
---|---|
MONDAY | The fulfillment order pickup hour weekday constant for monday. |
TUESDAY | The fulfillment order pickup hour weekday constant for tuesday. |
WEDNESDAY | The fulfillment order pickup hour weekday constant for wednesday. |
THURSDAY | The fulfillment order pickup hour weekday constant for thursday. |
FRIDAY | The fulfillment order pickup hour weekday constant for friday. |
SATURDAY | The fulfillment order pickup hour weekday constant for saturday. |
SUNDAY | The fulfillment order pickup hour weekday constant for sunday. |
FulfillmentOrderRecipient
Field Name | Field Type | Description |
---|---|---|
name | String | The fulfillment order recipient name. |
phone | String | The fulfillment order recipient phone. Optional |
identifier | String | The fulfillment order recipient identifier. Optional. |
FulfillmentOrderDiscount
Field Name | Field Type | Description |
---|---|---|
type | FulfillmentOrderDiscountType | The discount type. |
amount | Money | The fulfillment order discount amount. |
FulfillmentOrderDiscountType
Type | Description |
---|---|
SHIPPING | The fulfillment order discount by shipping. |
PROMOTION | The fulfillment order discount by promotion. |
PAYMENT_METHOD | The fulfillment order discount by payment. |
TOTAL_OF_DISCOUNTS | The fulfillment order total discounts. |
FulfillmentOrderDestination
Field Name | Field Type | Description |
---|---|---|
zipcode | String | The address zipcode. Optional. |
street | String | The address street. |
number | String | The address number. Optional. |
floor | String | The address floor. Brazil's complement. Optional. |
locality | String | The address locality. Brazil's neighborhood. Optional. |
city | String | The address city name. Optional. |
reference | String | The address reference. Optional. |
between_streets | String | The address between streets. Optional. |
province | Province | The address province. Optional. |
region | Region | The address Region. Optional. |
country | Country | The address Country. Optional. |
FulfillmentOrderStatus
Type | Description |
---|---|
UNPACKED | The fulfillment initial state, same as not started. |
PACKED | The fulfillment order was packed, same as ready for sending. |
DISPATCHED | The fulfillment order was sent. |
READY_FOR_PICKUP | The fulfillment order was ready for pickup. |
DELIVERED | The fulfillment order was fully fulfilled. |
Workflow
The Fulfillment Order Status Workflow has some validations by Fulfillment Order Shipping Type.
Below are the diagrams indicating the expected flows.
- The solid lines indicate indicates the most common and expected workflow.
- The dotted lines indicate the alternative allowed workflows.
- Depending on the fulfillment order's shipping type, certain flows are not applicable. For example, the
READY_FOR_PICKUP
status applies only to the pickup Shipping Type, whilenon-shippable
Shipping Types expect only theDELIVERED
status. - It is possible to go back to
UNPACKED
only fromPACKED
status.
FulfillmentOrderShippingType as 'ship'
ship
are used for shipping physical products directly to the consumer's home. Ex.: Shipping a t-shirt.
FulfillmentOrderShippingType as 'pickup'
pickup
are used for shipping physical products directly to a pickup point. Ex.: Shipping a t-shirt.
FulfillmentOrderShippingType as 'non-shippable'
non-shippable
are used for shipments of non-physical products to the consumer. Ex: classes sent to the consumer's email.
FulfillmentOrderStatusHistory
Field Name | Field Type | Description |
---|---|---|
from_status | FulfillmentOrderStatus | The fulfillment order from status. Nullable. |
to_status | FulfillmentOrderStatus | The fulfillment order to status. Nullable. |
happened_at | DateTime | Date when the fulfillment order history was happened in ISO 8601 format. |
created_at | DateTime | Date when the fulfillment order history was created in ISO 8601 format. |
FulfillmentOrderTrackingInfo
Field Name | Field Type | Description |
---|---|---|
url | String | The fulfillment order tracking info url. Nullable. |
code | String | The fulfillment order tracking info code. Nullable. |
FulfillmentOrderTrackingInfoHistory
Field Name | Field Type | Description |
---|---|---|
from_tracking_info | FulfillmentOrderTrackingInfo | The fulfillment order from tracking info. Nullable. |
to_tracking_info | FulfillmentOrderTrackingInfo | The fulfillment order to tracking info. Nullable. |
happened_at | DateTime | Date when the fulfillment order history was happened in ISO 8601 format. |
created_at | DateTime | Date when the fulfillment order history was created in ISO 8601 format. |
app_id | String | App ID of the app who made this change. |
user_id | String | User ID of the person who made this change. |
FulfillmentOrderTrackingEvent
Field Name | Field Type | Description |
---|---|---|
id | ID | The fulfillment order tracking event identification. (ULID) |
status | FulfillmentOrderTrackingEventStatus | The fulfillment order tracking event status. |
description | String | The fulfillment order tracking event description. |
address | String | The fulfillment order tracking event address information. Eg.: "St. Paul 123 - Ciudad - AR 1298". Nullable. |
geolocation | FulfillmentOrderTrackingEventGeolocation | The fulfillment order tracking event geolocation. Nullable. |
happened_at | DateTime | Date when the fulfillment order tracking event happened in ISO 8601 format. If Null Assumed NOW |
estimated_delivery_at | DateTime | Date when the fulfillment order tracking event estimated delivery at in ISO 8601 format. Nullable. |
created_at | DateTime | Date when the fulfillment order tracking event was created in ISO 8601 format. |
updated_at | DateTime | Date when the fulfillment order tracking event was updated in ISO 8601 format. |
FulfillmentOrderTrackingEventStatus
Type | Description |
---|---|
dispatched | Package has been posted by the merchant. |
received_by_post_office | Package has been received by the Shipping Carrier. |
in_transit | Package is in transit. |
out_for_delivery | Package is out for delivery. |
delivery_attempt_failed | Package could not be delivered. |
delayed | Package delayed. |
ready_for_pickup | Package is ready for pickup. |
delivered | Package was delivered. |
returned_to_sender | Package was returned to the sender. |
lost | Package lost. |
failure | Package delivery failed. |
custom_{status} | Package any custom status informed by a shipping partner. |
FulfillmentOrderTrackingEventGeolocation
Field Name | Field Type | Description |
---|---|---|
longitude | Decimal | The fulfillment order tracking event geolocation longitude. |
latitude | Decimal | The fulfillment order tracking event geolocation latitude. |
Money
Field Name | Field Type | Description |
---|---|---|
value | Decimal | The amount value |
currency | String | The isocode currency code |
Carrier
Field Name | Field Type | Description |
---|---|---|
carrier_id | String | The carrier identification. It could be alphanumeric identification like current shipping native methods or shipping carrier id identification. |
code | CarrierCodeType | The carrier code type. |
name | String | The carrier name. |
app_id | String | The carrier application identification. Default: null . |
CarrierCodeType
Type | Description |
---|---|
api | The shipping carrier is a shipping method from carriers API. |
custom | The shipping carrier is a shipping method from customs configured by merchant. |
locale | The shipping carrier is a shipping method from locales (branchs) configured by merchant. |
international | The shipping carrier is a shipping from international customs configured by merchant. |
native | The shipping carrier is a shipping from a internal integration created by Nuvemshop/Tiendanube and configured by merchant. |
draft | The shipping carrier is a shipping from draft orders. |
default | The shipping carrier is a shipping from default orders. |
Option
Field Name | Field Type | Description |
---|---|---|
name | String | The option name. |
code | String | The option code. |
reference | String | The option reference. |
allow_free_shipping | Boolean | The option allows a free shipping flag indicator. Default: null. |
Address
Field Name | Field Type | Description |
---|---|---|
zipcode | String | The address zipcode. Optional. |
street | String | The address street. |
number | String | The address number. Optional. |
floor | String | The address floor. Brazil's complement. Optional. |
locality | String | The address locality. Brazil's neighborhood. Optional. |
city | String | The address city name. Optional. |
reference | String | The address reference. Optional. |
between_streets | String | The address between streets. Optional. |
province | Province | The address province. Optional. |
region | Region | The address Region. Optional. |
country | Country | The address Country. Optional. |
Provice
Field Name | Field Type | Description |
---|---|---|
name | String | The province name. |
code | String | The province code. |
Region
Field Name | Field Type | Description |
---|---|---|
name | String | The region name. |
code | String | The region code. |
Country
Field Name | Field Type | Description |
---|---|---|
name | String | The country name. |
code | String | The country code. |
FulfillmentOrderPaginated
Field Name | Field Type | Description |
---|---|---|
total | UnsignedInt | Total of FulfillmentOrder. |
page | UnsignedInt | Current page. |
per_page | UnsignedInt | Quantity of FulfillmentOrder per page. |
results | FulfillmentOrder[] | List of fulfillment orders. |
Error
Field Name | Field Type | Description |
---|---|---|
description | String | Http status description. |
message | String | Error Message. |
Validation
Field Name | Field Type | Description |
---|---|---|
description | String | Http status description. |
messages | Message[] | List of inputs validation messages. |
Message
Type | Description |
---|---|
String[] | The error message input. This value is dynamic. Eg.: "shipping.carrier.carrier_id": ["should not be empty", "must be a string"]. |
Input Request Properties
FulfillmentOrderInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
assigned_location | FulfillmentOrderAssignedLocationInput | ✅ | ❌ | The fulfillment order assigned location. |
line_items | FulfillmentOrderLineItemInput[] | ✅ | ❌ | The fulfillment order line item input list. |
recipient | FulfillmentOrderRecipientInput | ✅ | ❌ | The fulfillment order recipient input. |
destination | FulfillmentOrderDestinationInput | ✅ | ✅ | The fulfillment order destination input. |
shipping | FulfillmentOrderShippingInput | ✅ | ✅ | The fulfillment order shipping input. |
FulfillmentOrderAssignedLocationInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
id | ID | ✅ | ❌ | The fulfillment order assigned location input identification. (ULID) |
FulfillmentOrderLineItemInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
quantity | UnsignedInt | ✅ | ❌ | The fulfillment order line item input quantity. |
order_line_item_id | ID | ✅ | ❌ | The order line item identification reference. |
FulfillmentOrderRecipientInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
name | String | ✅ | ❌ | The fulfillment order recipient input name. |
phone | String | ✅ | ✅ | The fulfillment order recipient input phone. |
identifier | String | ✅ | ✅ | The fulfillment order recipient input identifier. |
FulfillmentOrderShippingInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
type | FulfillmentOrderShippingType | ✅ | ❌ | The fulfillment order shipping type. Eg.: pickup, ship. |
carrier | CarrierInput | ✅ | ✅ | The fulfillment order shipping carrier input. |
option | OptionInput | ✅ | ✅ | The fulfillment order shipping option input. |
merchant_cost | MoneyInput | ✅ | ❌ | The fulfillment order merchant shipping cost. |
consumer_cost | MoneyInput | ✅ | ❌ | The fulfillment order consumer shipping cost. |
min_delivery_date | DateTime | ✅ | ✅ | The fulfillment order shipping min delivery date. |
max_delivery_date | DateTime | ✅ | ✅ | The fulfillment order shipping max delivery date. |
pickup_details | PickupDetailsInput | ✅ | ✅ | The fulfillment order shipping pickup details. |
CarrierInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
id | String | ✅ | ❌ | The shipping carrier input identification. Eg.: "1234", "correios", "oca". |
code | CarrierCodeTypeInput | ✅ | ❌ | The shipping carrier input type. |
app_id | String | ❌ | ✅ | The shipping carrier application identification. Default: null |
CarrierCodeTypeInput
Type | Description |
---|---|
api | The shipping carrier is a shipping method from carriers API. |
custom | The shipping carrier is a shipping method from customs configured by merchant. |
locale | The shipping carrier is a shipping method from locales (branchs) configured by merchant. |
international | The shipping carrier is a shipping from international customs configured by merchant. |
native | The shipping carrier is a shipping from a internal integration created by Nuvemshop/Tiendanube and configured by merchant. |
draft | The shipping carrier is a shipping from draft orders. |
default | The shipping carrier is a shipping from default orders. |
OptionInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
code | String | ✅ | ❌ | The shipping option input code. Eg.: "pac", "sedex". |
reference | String | ✅ | ✅ | The shipping option input reference. |
allow_free_shipping | String | ❌ | ✅ | The shipping option input allows free shipping flag indicator. Default: false. |
PickupDetailsInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
location_id | String | ✅ | ❌ | The shipping pickup details input identification. |
name | String | ✅ | ❌ | The shipping pickup details input name. |
address | AddreeInput | ✅ | ❌ | The shipping pickup details input address. |
pickup_hours | PickupHourInput[] | ❌ | ❌ | The shipping pickup details input pickup hours. Default: []. |
PickupHourInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
day | FulfillmentOrderPickupHourWeekday | ✅ | ❌ | The fulfillment order shipping pickup details the weekday. Eg.: MONDAY |
start | String | ✅ | ❌ | The fulfillment order shipping pickup detail pickup hour the start hour. Eg.: 0800 |
end | String | ✅ | ❌ | The fulfillment order shipping pickup detail pickup hour the end hour. Eg.: 1800 |
ExtraPropertyInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
free_shipping_info | FreeShippingInput | ❌ | ❌ | The shipping extra property input for free shipping information. |
phone_required | Boolean | ❌ | ❌ | The shipping option requires a consumer phone number flag indicator. |
id_required | Boolean | ❌ | ❌ | The shipping option requires a consumer document number flag indicator. |
accepts_cod | Boolean | ❌ | ❌ | The shipping option accepts cash on delivery flag indicator. |
show_time | Boolean | ❌ | ❌ | The shipping option must show the estimated delivery time flag indicator. |
shippable | Boolean | ❌ | ❌ | The shipping option is shippable, meaning the package will be sent to the consumer or to the pickup point. |
FreeShippingInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
free_shipping_id | ID | ✅ | ❌ | The shipping free shipping info input free shipping identification input. |
consumer_original_cost | Money | ✅ | ❌ | The shipping free shipping info input the consumer original shipping cost. |
FulfillmentOrderDestinationInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
zipcode | String | ✅ | ✅ | The fulfillment order destination input zipcode. |
street | String | ✅ | ❌ | The fulfillment order destination input street. |
number | String | ✅ | ✅ | The fulfillment order destination input number. |
floor | String | ✅ | ✅ | The fulfillment order destination input floor. |
locality | String | ✅ | ✅ | The fulfillment order destination input locality. |
city | String | ✅ | ✅ | The fulfillment order destination input city name. |
reference | String | ✅ | ✅ | The fulfillment order destination input reference. |
between_streets | String | ✅ | ✅ | The fulfillment order destination input between streets. |
province | ProvinceInput | ✅ | ✅ | The fulfillment order destination input province. |
region | RegionInput | ✅ | ✅ | The fulfillment order destination input region. |
country | CountryInput | ✅ | ❌ | The fulfillment order destination input country. |
FulfillmentOrderStatusInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
status | FulfillmentOrderStatus | ✅ | ❌ | The fulfillment order status input status. |
FulfillmentOrderTrackingInfoInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
code | String | ✅ | ✅ | The fulfillment order tracking info input tracking number. |
url | String | ✅ | ✅ | The fulfillment order tracking info input tracking number. |
notify_customer | Boolean | ✅ | ❌ | Notify the customer about the fulfillment (the default value is false) |
FulfillmentOrderTrackingEventInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
status | FulfillmentOrderTrackingEventStatus | ✅ | ❌ | The fulfillment order tracking event input status. |
description | String | ✅ | ❌ | The fulfillment order tracking event input description. |
address | String | ✅ | ✅ | The fulfillment order tracking event input address as one liner address. Ex: St. Julio 123, Ciudad, Argentina. |
geolocation | FulfillmentOrderTrackingEventGeolocationInput | ✅ | ✅ | The fulfillment order tracking event geolocation input. |
happened_at | DateTime | ✅ | ✅ | The fulfillment order tracking event input happened at the event. If null, the event was taken as now. |
estimated_delivery_at | DateTime | ✅ | ✅ | The fulfillment order tracking event input estimated delivery date time to arrive. |
FulfillmentOrderTrackingEventGeolocationInput
Field Name | Field Type | Mandatory | Nullable | Description |
---|---|---|---|---|
latitude | Decimal | ✅ | ❌ | The fulfillment order tracking event geolocation latitude input. |
longitude | Decimal |