NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Shipday

shipday

Making Local Deliveries Easy Globally - Powering Local E-commerce

EcommerceWeb del proveedor
Acciones
13
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (13)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add a CarrierSHIPDAY_ADD_A_CARRIERAcción

Tool to add a new carrier/driver to the Shipday system with credentials. Use when you need to create a new carrier account with name, email, and phone number.

Parámetros de entrada

  • namestringObligatorio

    Full name of the carrier/driver

  • emailstringObligatorio

    Email address for the carrier account

  • areaIdinteger

    Optional unique area ID for identifying the operational area

  • codeNamestring

    Optional code name for the carrier

  • carrierPhotostring

    Optional URL reference to the carrier's photo

  • phone_numberstringObligatorio

    Phone number of the carrier with country code in E.164 format (e.g., +11234567891)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check On-Demand Delivery AvailabilitySHIPDAY_CHECK_ON_DEMAND_AVAILABILITYAcción

Tool to check on-demand delivery availability from third-party service providers. Use when you need to verify service availability, pricing estimates, and delivery times for a route without creating an order.

Parámetros de entrada

  • pickupAddressstringObligatorio

    Complete pickup address as a single string (e.g., '350 5th Avenue, New York, NY 10118')

  • deliveryAddressstringObligatorio

    Complete delivery address as a single string (e.g., '20 West 34th Street, New York, NY 10001')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Edit Delivery OrderSHIPDAY_EDIT_DELIVERY_ORDERAcción

Tool to edit an existing delivery order in Shipday. Use when you need to update order details such as customer information, restaurant details, order items, delivery fees, or tips.

Parámetros de entrada

  • tipnumber

    Tip amount for the delivery

  • orderIdstringObligatorio

    The unique order identifier to edit. This is the order ID returned when the order was created.

  • customerobject

    Customer information for the order.

  • orderItemsobject[]

    List of items in the order with name, quantity, unit price, and optional details

  • restaurantobject

    Restaurant information for the order.

  • deliveryFeenumber

    Delivery fee amount

  • orderNumberstring

    Order reference number or identifier

  • totalOrderCostnumber

    Total cost of the order

  • expectedPickupTimestring

    Expected pickup time

  • deliveryInstructionstring

    Special instructions for the delivery

  • expectedDeliveryDatestring

    Expected delivery date in ISO format

  • expectedDeliveryTimestring

    Expected delivery time

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get On-Demand Delivery EstimateSHIPDAY_GET_ON_DEMAND_ESTIMATEAcción

Tool to get on-demand delivery estimates from third-party service providers for a specific order. Use when you need to retrieve pricing, pickup/delivery times, and durations for a delivery order.

Parámetros de entrada

  • orderIdstringObligatorio

    The identifier for the delivery order to get estimates for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get On-Demand Delivery ServicesSHIPDAY_GET_ON_DEMAND_SERVICESAcción

Tool to retrieve available third-party on-demand delivery service providers. Use when you need to check which delivery services are available or enabled for the account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Insert OrderSHIPDAY_INSERT_ORDERAcción

Tool to create a new delivery order in Shipday. Use when you need to insert a delivery order with customer details, restaurant information, order items, and delivery schedule.

Parámetros de entrada

  • taxnumber

    Tax amount

  • tipsnumber

    Tip/gratuity amount

  • cashTipsnumber

    Cash tip amount

  • orderItemsobject[]Obligatorio

    Array of order items with name, unitPrice, and quantity

  • deliveryFeenumber

    Delivery/shipping fee

  • orderNumberstringObligatorio

    Unique order reference number from customer platform

  • orderSourcestring

    Origin of the order (e.g., 'Seamless', 'Website')

  • additionalIdstring

    Secondary reference identifier

  • creditCardIdstring

    Credit card reference identifier

  • customerNamestringObligatorio

    Full name of the recipient

  • restaurantIdinteger

    Restaurant identifier

  • customerEmailstringObligatorio

    Customer email address

  • paymentMethodstringenum

    Payment method. Must be one of: cash, credit_card, CASH, CARD, ONLINE, CREDIT_CARD, CARD_PHONE

    cashcredit_cardCASHCARDONLINECREDIT_CARDCARD_PHONE
  • creditCardTypestringenum

    Type of credit card. Must be one of: visa, master_card, AMEX, other

    visamaster_cardAMEXother
  • discountAmountnumber

    Applied discount amount

  • pickupLatitudenumber

    Pickup location latitude coordinate

  • restaurantNamestringObligatorio

    Business/pickup location name

  • totalOrderCostnumberObligatorio

    Total order amount

  • customerAddressstringObligatorio

    Complete delivery address

  • pickupLongitudenumber

    Pickup location longitude coordinate

  • deliveryLatitudenumber

    Delivery location latitude coordinate

  • deliveryLongitudenumber

    Delivery location longitude coordinate

  • pickupInstructionstring

    Pickup-related instructions

  • restaurantAddressstringObligatorio

    Pickup location address

  • clientRestaurantIdstring

    Client's internal restaurant identifier

  • expectedPickupTimestringObligatorio

    Pickup time in YYYY-MM-DD HH:MM format or HH:MM:SS format

  • customerPhoneNumberstringObligatorio

    Customer phone number with country code

  • deliveryInstructionstring

    Special delivery instructions or notes

  • expectedDeliveryDatestringObligatorio

    Target delivery date in YYYY-MM-DD format

  • expectedDeliveryTimestringObligatorio

    Delivery time in YYYY-MM-DD HH:MM format or HH:MM:SS format

  • restaurantPhoneNumberstringObligatorio

    Business contact phone number

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Order Ready to PickupSHIPDAY_ORDER_READY_TO_PICKUPAcción

Tool to mark a delivery order as ready for pickup. Use when you need to notify Shipday that an order is prepared and ready for driver pickup at a specific time.

Parámetros de entrada

  • orderIdstringObligatorio

    Unique identifier for the delivery order to be marked as ready for pickup. This is the order ID returned when the order was created or can be retrieved from order details.

  • readyToPickupboolean

    Boolean flag indicating whether the order is ready for pickup. Set to true to mark the order as ready.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Orders QuerySHIPDAY_ORDERS_QUERYAcción

Tool to query delivery orders with filters and pagination. Use when you need to retrieve multiple orders within a specific time range or paginate through order results. ACTIVE orders are those which are neither ALREADY_DELIVERED nor FAILED_DELIVERY nor INCOMPLETE.

Parámetros de entrada

  • endTimestring

    End time for filtering orders in ISO 8601 format (e.g., '2023-12-04T00:00:00Z'). Filters orders up to this timestamp.

  • endCursorinteger

    Ending cursor for pagination (e.g., 100). Defines the end boundary for the paginated result set.

  • startTimestring

    Start time for filtering orders in ISO 8601 format (e.g., '2023-11-28T00:00:00Z'). Filters orders from this timestamp onwards.

  • startCursorinteger

    Starting cursor for pagination (e.g., 1). Used to paginate through result sets.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Query Delivery OrdersSHIPDAY_QUERY_DELIVERY_ORDERSAcción

Tool to query delivery orders with time-based filters and cursor pagination. Use when you need to retrieve multiple orders within a specific time range or paginate through order results.

Parámetros de entrada

  • endTimestring

    End time for the query in UTC ISO 8601 format (e.g., '2023-12-04T00:00:00Z'). Filters orders up to this timestamp.

  • endCursorinteger

    Ending cursor for pagination (e.g., 2). Defines the end boundary for the paginated result set.

  • startTimestring

    Start time for the query in UTC ISO 8601 format (e.g., '2023-11-28T00:00:00Z'). Filters orders from this timestamp onwards.

  • startCursorinteger

    Starting cursor for pagination (e.g., 1). Used to paginate through result sets.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Active OrdersSHIPDAY_RETRIEVE_ACTIVE_ORDERSAcción

Tool to retrieve all active delivery orders from Shipday system. Use when you need to get currently active orders (excludes ALREADY_DELIVERED, FAILED_DELIVERY, and INCOMPLETE orders). Returns at most 100 orders at a time.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve CarriersSHIPDAY_RETRIEVE_CARRIERSAcción

Tool to retrieve all carriers/drivers with profile and status details. Use when you need to get a list of all carriers in the system.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Order DetailsSHIPDAY_RETRIEVE_ORDER_DETAILSAcción

Tool to retrieve detailed information for a specific delivery order by order number. Use when you need to get comprehensive order details including customer info, restaurant info, carrier assignment, cost breakdown, order items, status, and tracking information.

Parámetros de entrada

  • order_numberstringObligatorio

    The order reference identifier to retrieve details for

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unassign Order from DriverSHIPDAY_UNASSIGN_ORDER_FROM_DRIVERAcción

Tool to remove driver assignment from a delivery order. Use when you need to unassign a driver from an order to make it available for reassignment to a different driver.

Parámetros de entrada

  • orderIdstringObligatorio

    Unique identifier for the delivery order to be unassigned from its current driver. This ID is returned when the order is placed and can be retrieved from order placement responses or via the delivery order details.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not