Alephee developers portal
  • Introduction
    • 📘API documentation
      • Introduction to integrations
    • ⚙️Using the API
      • 🔒Authentication
      • 🏹Swagger
    • 📡Overall index of methods
  • Usage limiting
    • 🕑Rate limiting
    • 🔃Limits per request
    • ♒Limits HTTP headers responses
    • ⚠️Usage limits by endpoint
  • Accounts
    • GET methods
      • Accounts
        • ⚠️Usage limiting
        • ⬆️Request and Respone
        • ⌨️Type specifications
        • ⚙️Examples
      • Marketplaces
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Price Lists
        • ⚠️Usage limiting
        • ⬆️Request and Responses
        • ⌨️Type specifications
        • ⚙️Examples
      • Stores
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Login Token
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • 📊Business rules
        • Standard usage flow for Alephee B2B portal
        • ⌨️Type specifications
        • ⚙️Examples
    • PUT methods
      • Update account fiscal tax rules
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
  • Orders
    • Logical model
      • ℹ️What is an order?
      • 📂Order model overview
      • 🛒Shopping cart orders
        • 🔳Cart order model overview
        • 〽️Mercado Libre’s shopping cart orders
      • 💴Approved payments and pending payments
      • 🗒️General notes
    • GET methods
      • 👩‍💻Orders
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
        • ⁉️Useful tips
      • 🛒Orders List From A Shopping Cart
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • 📄Orders Document
        • ⚠️Usage limiting
        • ⬆️Request and Response
      • 🧾Order Shipping Label
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⚙️Examples
    • PUT methods
      • 📑Update orders status
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • 👨‍💼Mark orders as integrated
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • 📑Attach document to an order
        • ⚠️Usage limiting
        • Allowed document types and formats
        • ⬆️Request and Response
        • ⚙️Examples
        • ⚙️Example using POSTMAN via form-data
        • ⚙️Example using POSTMAN via JSON body
      • 📑Split an order
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
      • 📨Send a message to a buyer
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⚙️Examples
      • 📝Create a new order
        • ⚠️Usage limiting
        • Introduction
        • 📊Business rules
        • 📑Order mandatory sections
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • DELETE methods
      • 📑Delete an order
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⚙️Examples
  • Orders shipping
    • GET methods
      • Shipping Packaging Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Shipping Scheduling Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Shipping Transportation Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • Set Shipping Packaging Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⚙️Examples
  • Products
    • GET methods
      • Products
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • Logical model
      • Business Rules
        • Prices considerations
        • Available prices attributes combinations to set prices
        • Stock considerations
        • Alephee B2B portals prices and stock considerations
        • Measurable quantity and price considerations
      • Update Products
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • PUT methods
      • Update product fiscal information
        • ⚠️Usage limiting
        • 🗒️Notes
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • DELETE methods
      • Delete products from a price list
        • ⚠️Usage limiting
        • 📊Business rules
        • ‼️Warnings
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⌨️Result type specifications
        • ⚙️Examples
        • Most common validation error messages and how to fix them.
  • Product listings
    • GET methods
      • Product Listings
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • Set product listings discounts
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • PUT methods
      • Update product listings
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Set product listings status
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
  • GLOSSARY
    • Conventions
    • Response status codes
    • Marketplaces/Channels ID and names list
    • Product listings status list
    • Orders and shipping glossary
      • Available order statuses codes
      • State transitions diagram
      • Automatic and manual order status updates
      • Attaching documents to orders
      • Shipping labels
  • TROUBLESHOOTING
    • ❗Important tips
    • ✅Best integrations practices
Powered by GitBook
On this page
  • SchedulingInfo
  • SchedulingShipping
  • SchedulingSchedule
  • SchedulingHandling
  • SchedulingDelivery
  • SchedulingDelivered

Was this helpful?

  1. Orders shipping
  2. GET methods
  3. Shipping Scheduling Information

Type specifications

Response from the API endpoint...

SchedulingInfo

Property
Type
Description

Id

string

Alephee ID to identify the order

SellerAccount

The seller to whom the orders belong to.

Marketplace

{

Key (integer),

Value (string),

Channel (string)

}

ID of the marketplace in which the order originated.

See marketplaces ID section and the GET marketplaces endpoint for the coding reference.

Channel property is available on the following scenarios:

Mercado Libre: When the sale came from a “Mercado Shops” sale the string contains this name.

Shipping

Information about the shipping and scheduling dates

SchedulingShipping

Property
Type
Description

Status

{

Key (integer),

Value (string)

}

Current status of the shipping. For further details see “Possible order statuses” section below

LogisticType

{

Key (integer),

Value (string)

}

LogisticType, LogisticName:

1 = to_be_agreed

2 = me1

3 = me2, 4 = custom,

5 = fulfillment

6 = flex 7 = pickup

8 = cross_docking

14 = courier 15 = flex-turbo

Schedule

Shipping schedule dates

Handling

Shipping handling dates

Delivery

Shipping delivery dates

Delivered

Shipping after-delivered dates

SchedulingSchedule

Property
Type
Description

Created

datetime? (UTC with local user time zone)

The date the shipment was created. It is almost always the same date and time from the order creation.

Updated

datetime? (UTC with local user time zone)

The last time that the shipping was updated.

FirstPrinted

datetime? (UTC with local user time zone)

The FIRST time that the shipping label was printed.

Schedule

datetime? (UTC with local user time zone)

The estimated date that the marketplace will handle the shipping process.

Expiration

datetime? (UTC with local user time zone)

Customer deadline to provide feedback and rating to the order.

SchedulingHandling

Property
Type
Description

Approved

datetime? (UTC with local user time zone)

Date from which the handling is approved by the marketplace.

Limit

datetime? (UTC with local user time zone)

Deadline for seller to handle and prepare the shipping.

SchedulingDelivery

Property
Type
Description

Estimated

datetime? (UTC with local user time zone)

Deadline for seller to ship an item. Only the date is considered since the time is entered just to maintain the structure. In other words, you have the whole day indicated in the field to ship the item before it automatically goes to delayed on the following day

Extended

datetime? (UTC with local user time zone)

Second delivery promise, if the original promise is not fulfilled.

Limit

datetime? (UTC with local user time zone)

Deadline for the buyer to cancel the purchase and request a refund, if the customer has not received the shipment yet.

Final

datetime? (UTC with local user time zone)

Final deadline to receive the shipment and define its final status, which may be either delivered or not delivered if a claim was filed.

Buffering

datetime? (UTC with local user time zone)

When carriers are exceeding their capacity of shipping products and the shipping deadline is missed, this date will be the corresponding date that the package must be dispatched and that same day the label will be available for printing.

This attribute is available for orders created AFTER 2022-06-30. Before that date, this attribute es null.

SchedulingDelivered

Property
Type
Description

Delivered

datetime? (UTC with local user time zone)

Date and time of the fulfilled and delivered shipping.

Carrier

string

Carrier information about the deliver.

PreviousRequest and ResponseNextExamples

Last updated 8 months ago

Was this helpful?

⌨️
SchedulingShipping
SchedulingSchedule
SchedulingHandling
SchedulingDelivery
SchedulingDelivered
Seller