notifyShipmentPickup
Notifies the pickup of a shipment.
-
Notes:
-
The Courier ID can be obtained using the couriers GraphQL query.
-
Once the order is marked as completed by the pharmacy (either manually through the partner home interface or automatically via API), the value of the hasShipment field will change from false to true.
-
For standard orders with delivery type, the shipment is handled by a courier. Therefore, it is necessary to notify the courier to come and pick up the order prepared by the pharmacy.
-
In the case of same-day orders, the orders are shipped using delivery services provided by the pharmacies themselves (Botendienst), and we need to inform the platform that the order has been sent to the customer.
-
This mutation allows you to notify which products you want to include in the shipment notification. You must process the shipment for the entire order providing the product IDs obtained from the previous "Search Orders" mutation. If you don't want to notify all products you must cancel the products that you can't not send before notifying the shipment.
-
Please note that you can only notify the items of a suborder once. If you attempt to notify them multiple times, you will receive an error message. It's important to clarify whether you are notifying a full or partial shipment. After the notification, if you search for this order using the "Search Orders" mutation, it is possible that it will still appear with has_shipment = false. This can happen because the notification process is complex and asynchronous.
-
notifyShipmentPickup(
orderId: ID!
subOrderId: ID!
sellerId: ID!
products: [NotifyShipmentPickupProductsInput!]!
courierId: ID
trackingNumber: String
): NotifyShipmentPickup!
Arguments
notifyShipmentPickup.orderId ● ID! non-null scalar
The ID of the order. Format: UUID
notifyShipmentPickup.subOrderId ● ID! non-null scalar
The ID of the suborder. Format: UUID
notifyShipmentPickup.sellerId ● ID! non-null scalar
The ID of the seller. Format: UUID
notifyShipmentPickup.products ● [NotifyShipmentPickupProductsInput!]! non-null input
The products included in the pickup notification to be cancelled.
notifyShipmentPickup.courierId ● ID scalar
The ID of the courier. Format: UUID Courier ids can be retrieved from couriers GraphQL query. For same day orders it has to be null
notifyShipmentPickup.trackingNumber ● String scalar
The tracking number for the shipment.
Type
NotifyShipmentPickup object
Represents the response of notifying the pickup of a shipment.